> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agents.kolena.com/llms.txt
> Use this file to discover all available pages before exploring further.

# kolena_agents.types.api_key

## `ApiKeyInfo`

ApiKeyInfo

### `id`

```python theme={null}
id: StrictStr
```

The ID of this API key.

### `name`

```python theme={null}
name: StrictStr
```

The name of this API key.

### `created_at`

```python theme={null}
created_at: datetime
```

When this API key was created, formatted as an ISO 8601 timestamp (e.g. `2025-12-31T10:15:45+00:00`)

### `expires_at`

```python theme={null}
expires_at: Optional[datetime]
```

### `created_by`

```python theme={null}
created_by: StrictStr
```

The email address of the user who created this API key.

### `last_used_at`

```python theme={null}
last_used_at: Optional[datetime]
```

### `status`

```python theme={null}
status: ApiKeyStatus
```

The current status of this API key (active or expired).

### `api_key_hint`

```python theme={null}
api_key_hint: StrictStr
```

Partial API key hint

## `ApiKeyStatus`

ApiKeyStatus

### `ACTIVE`

```python theme={null}
ACTIVE = 'active'
```

### `EXPIRED`

```python theme={null}
EXPIRED = 'expired'
```

## `ClientApiKeyCreateRequest`

ClientApiKeyCreateRequest

### `name`

```python theme={null}
name: str
```

### `expiration_days`

```python theme={null}
expiration_days: Optional[
    Annotated[int, Field(le=3650, strict=True)]
] = None

```

The number of days until the API key expires.

## `ClientApiKeyCreateResponse`

ClientApiKeyCreateResponse

### `id`

```python theme={null}
id: StrictStr
```

The ID of this API key.

### `name`

```python theme={null}
name: StrictStr
```

The name of this API key.

### `created_at`

```python theme={null}
created_at: datetime
```

When this API key was created, formatted as an ISO 8601 timestamp (e.g. `2025-12-31T10:15:45+00:00`)

### `expires_at`

```python theme={null}
expires_at: Optional[datetime]
```

### `created_by`

```python theme={null}
created_by: StrictStr
```

The email address of the user who created this API key.

### `last_used_at`

```python theme={null}
last_used_at: Optional[datetime]
```

### `status`

```python theme={null}
status: ApiKeyStatus
```

The current status of this API key (active or expired).

### `api_key_hint`

```python theme={null}
api_key_hint: StrictStr
```

Partial API key hint

### `api_key`

```python theme={null}
api_key: StrictStr
```

The API key secret.

## `ClientApiKeyListResponse`

ClientApiKeyListResponse

### `api_keys`

```python theme={null}
api_keys: List[ApiKeyInfo]
```

The fetched page of API keys.

### `total_pages`

```python theme={null}
total_pages: StrictInt
```

The total number of pages of API keys. Use the request arguments `page_number` and `page_size` to control which API keys are fetched.

### `page_number`

```python theme={null}
page_number: StrictInt
```

The number of the fetched page.

### `page_size`

```python theme={null}
page_size: StrictInt
```

The page size, i.e. number of API keys, fetched.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.