# Tokens

## List tokens.

`aisearch.tokens.list(TokenListParams**kwargs)  -> SyncV4PagePaginationArray[TokenListResponse]`

**get** `/accounts/{account_id}/ai-search/tokens`

List tokens.

### Parameters

- `account_id: str`

- `page: Optional[int]`

  Page number (1-indexed).

- `per_page: Optional[int]`

  Number of results per page.

- `search: Optional[str]`

  Filter tokens whose name contains this string (case-insensitive).

### Returns

- `class TokenListResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.aisearch.tokens.list(
    account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
)
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "cf_api_id": "cf_api_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "created_by": "created_by",
      "enabled": true,
      "legacy": true,
      "modified_by": "modified_by"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}
```

## Create token.

`aisearch.tokens.create(TokenCreateParams**kwargs)  -> TokenCreateResponse`

**post** `/accounts/{account_id}/ai-search/tokens`

Create a new token.

### Parameters

- `account_id: str`

- `cf_api_id: str`

- `cf_api_key: str`

- `name: str`

- `legacy: Optional[bool]`

### Returns

- `class TokenCreateResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
token = client.aisearch.tokens.create(
    account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
    cf_api_id="a1b2c3d4e5f6",
    cf_api_key="abc123",
    name="my-token",
)
print(token.id)
```

#### Response

```json
{
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "cf_api_id": "cf_api_id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "created_by": "created_by",
    "enabled": true,
    "legacy": true,
    "modified_by": "modified_by"
  },
  "success": true
}
```

## Read token.

`aisearch.tokens.read(strid, TokenReadParams**kwargs)  -> TokenReadResponse`

**get** `/accounts/{account_id}/ai-search/tokens/{id}`

Read token.

### Parameters

- `account_id: str`

- `id: str`

### Returns

- `class TokenReadResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.aisearch.tokens.read(
    id="62af0db3-c410-40b2-9ee3-0e93f6dd1de0",
    account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
)
print(response.id)
```

#### Response

```json
{
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "cf_api_id": "cf_api_id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "created_by": "created_by",
    "enabled": true,
    "legacy": true,
    "modified_by": "modified_by"
  },
  "success": true
}
```

## Update token.

`aisearch.tokens.update(strid, TokenUpdateParams**kwargs)  -> TokenUpdateResponse`

**put** `/accounts/{account_id}/ai-search/tokens/{id}`

Update token.

### Parameters

- `account_id: str`

- `id: str`

- `cf_api_id: str`

- `cf_api_key: str`

- `name: str`

- `legacy: Optional[bool]`

### Returns

- `class TokenUpdateResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
token = client.aisearch.tokens.update(
    id="62af0db3-c410-40b2-9ee3-0e93f6dd1de0",
    account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
    cf_api_id="a1b2c3d4e5f6",
    cf_api_key="abc123",
    name="my-token",
)
print(token.id)
```

#### Response

```json
{
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "cf_api_id": "cf_api_id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "created_by": "created_by",
    "enabled": true,
    "legacy": true,
    "modified_by": "modified_by"
  },
  "success": true
}
```

## Delete token.

`aisearch.tokens.delete(strid, TokenDeleteParams**kwargs)  -> object`

**delete** `/accounts/{account_id}/ai-search/tokens/{id}`

Delete token.

### Parameters

- `account_id: str`

- `id: str`

### Returns

- `object`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
token = client.aisearch.tokens.delete(
    id="62af0db3-c410-40b2-9ee3-0e93f6dd1de0",
    account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
)
print(token)
```

#### Response

```json
{
  "result": {},
  "success": true
}
```

## Domain Types

### Token List Response

- `class TokenListResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`

### Token Create Response

- `class TokenCreateResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`

### Token Read Response

- `class TokenReadResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`

### Token Update Response

- `class TokenUpdateResponse: …`

  - `id: str`

  - `cf_api_id: str`

  - `created_at: datetime`

  - `modified_at: datetime`

  - `name: str`

  - `created_by: Optional[str]`

  - `enabled: Optional[bool]`

  - `legacy: Optional[bool]`

  - `modified_by: Optional[str]`