# Namespaces

## List namespaces.

`client.aiSearch.namespaces.list(NamespaceListParamsparams?, RequestOptionsoptions?): V4PagePaginationArray<NamespaceListResponse>`

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

List namespaces.

### Parameters

- `params: NamespaceListParams`

  - `account_id?: string`

    Path param

  - `order_by?: "created_at"`

    Query param: Order By Column Name

    - `"created_at"`

  - `order_by_direction?: "asc" | "desc"`

    Query param: Order By Direction

    - `"asc"`

    - `"desc"`

  - `page?: number`

    Query param

  - `per_page?: number`

    Query param

### Returns

- `NamespaceListResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const namespaceListResponse of client.aiSearch.namespaces.list({
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
})) {
  console.log(namespaceListResponse.created_at);
}
```

#### Response

```json
{
  "result": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "production",
      "description": "Production environment"
    }
  ],
  "success": true
}
```

## Create new namespaces.

`client.aiSearch.namespaces.create(NamespaceCreateParamsparams, RequestOptionsoptions?): NamespaceCreateResponse`

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

Create a new namespaces.

### Parameters

- `params: NamespaceCreateParams`

  - `account_id?: string`

    Path param

  - `name: string`

    Body param

  - `description?: string | null`

    Body param: Optional description for the namespace. Max 256 characters.

### Returns

- `NamespaceCreateResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const namespace = await client.aiSearch.namespaces.create({
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
  name: 'production',
});

console.log(namespace.created_at);
```

#### Response

```json
{
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "production",
    "description": "Production environment"
  },
  "success": true
}
```

## Read namespace.

`client.aiSearch.namespaces.read(stringname, NamespaceReadParamsparams?, RequestOptionsoptions?): NamespaceReadResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}`

Read namespace.

### Parameters

- `name: string`

- `params: NamespaceReadParams`

  - `account_id?: string`

### Returns

- `NamespaceReadResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.read('production', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(response.created_at);
```

#### Response

```json
{
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "production",
    "description": "Production environment"
  },
  "success": true
}
```

## Update namespace.

`client.aiSearch.namespaces.update(stringname, NamespaceUpdateParamsparams?, RequestOptionsoptions?): NamespaceUpdateResponse`

**put** `/accounts/{account_id}/ai-search/namespaces/{name}`

Update namespace.

### Parameters

- `name: string`

- `params: NamespaceUpdateParams`

  - `account_id?: string`

    Path param

  - `description?: string | null`

    Body param: Optional description for the namespace. Max 256 characters.

### Returns

- `NamespaceUpdateResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const namespace = await client.aiSearch.namespaces.update('production', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(namespace.created_at);
```

#### Response

```json
{
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "production",
    "description": "Production environment"
  },
  "success": true
}
```

## Delete namespace.

`client.aiSearch.namespaces.delete(stringname, NamespaceDeleteParamsparams?, RequestOptionsoptions?): NamespaceDeleteResponse`

**delete** `/accounts/{account_id}/ai-search/namespaces/{name}`

Delete namespace.

### Parameters

- `name: string`

- `params: NamespaceDeleteParams`

  - `account_id?: string`

### Returns

- `NamespaceDeleteResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const namespace = await client.aiSearch.namespaces.delete('production', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(namespace.created_at);
```

#### Response

```json
{
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "production",
    "description": "Production environment"
  },
  "success": true
}
```

## Multi-Instance Search

`client.aiSearch.namespaces.search(stringname, NamespaceSearchParamsparams, RequestOptionsoptions?): NamespaceSearchResponse`

**post** `/accounts/{account_id}/ai-search/namespaces/{name}/search`

Multi-Instance Search

### Parameters

- `name: string`

- `params: NamespaceSearchParams`

  - `account_id?: string`

    Path param

  - `ai_search_options: AISearchOptions`

    Body param

    - `instance_ids: Array<string>`

    - `cache?: Cache`

      - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

        - `"super_strict_match"`

        - `"close_enough"`

        - `"flexible_friend"`

        - `"anything_goes"`

      - `enabled?: boolean`

    - `query_rewrite?: QueryRewrite`

      - `enabled?: boolean`

      - `model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more`

        - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

        - `"@cf/zai-org/glm-4.7-flash"`

        - `"@cf/meta/llama-3.1-8b-instruct-fast"`

        - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

        - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

        - `"@cf/qwen/qwen3-30b-a3b-fp8"`

        - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

        - `"@cf/moonshotai/kimi-k2-instruct"`

        - `"@cf/google/gemma-3-12b-it"`

        - `"@cf/google/gemma-4-26b-a4b-it"`

        - `"@cf/moonshotai/kimi-k2.5"`

        - `"anthropic/claude-3-7-sonnet"`

        - `"anthropic/claude-sonnet-4"`

        - `"anthropic/claude-opus-4"`

        - `"anthropic/claude-3-5-haiku"`

        - `"cerebras/qwen-3-235b-a22b-instruct"`

        - `"cerebras/qwen-3-235b-a22b-thinking"`

        - `"cerebras/llama-3.3-70b"`

        - `"cerebras/llama-4-maverick-17b-128e-instruct"`

        - `"cerebras/llama-4-scout-17b-16e-instruct"`

        - `"cerebras/gpt-oss-120b"`

        - `"google-ai-studio/gemini-2.5-flash"`

        - `"google-ai-studio/gemini-2.5-pro"`

        - `"grok/grok-4"`

        - `"groq/llama-3.3-70b-versatile"`

        - `"groq/llama-3.1-8b-instant"`

        - `"openai/gpt-5"`

        - `"openai/gpt-5-mini"`

        - `"openai/gpt-5-nano"`

        - `""`

      - `rewrite_prompt?: string`

    - `reranking?: Reranking`

      - `enabled?: boolean`

      - `match_threshold?: number`

      - `model?: "@cf/baai/bge-reranker-base" | ""`

        - `"@cf/baai/bge-reranker-base"`

        - `""`

    - `retrieval?: Retrieval`

      - `boost_by?: Array<BoostBy>`

        Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

        - `field: string`

          Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

        - `direction?: "asc" | "desc" | "exists" | "not_exists"`

          Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

          - `"asc"`

          - `"desc"`

          - `"exists"`

          - `"not_exists"`

      - `context_expansion?: number`

      - `filters?: Record<string, unknown>`

      - `fusion_method?: "max" | "rrf"`

        - `"max"`

        - `"rrf"`

      - `keyword_match_mode?: "and" | "or"`

        Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

        - `"and"`

        - `"or"`

      - `match_threshold?: number`

      - `max_num_results?: number`

      - `retrieval_type?: "vector" | "keyword" | "hybrid"`

        - `"vector"`

        - `"keyword"`

        - `"hybrid"`

      - `return_on_failure?: boolean`

  - `messages?: Array<Message>`

    Body param

    - `content: string | null`

    - `role: "system" | "developer" | "user" | 2 more`

      - `"system"`

      - `"developer"`

      - `"user"`

      - `"assistant"`

      - `"tool"`

  - `query?: string`

    Body param: A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both.

### Returns

- `NamespaceSearchResponse`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `instance_id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `search_query: string`

  - `errors?: Array<Error>`

    - `instance_id: string`

    - `message: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.search('my-namespace', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
  ai_search_options: { instance_ids: ['my-ai-search'] },
});

console.log(response.chunks);
```

#### Response

```json
{
  "result": {
    "chunks": [
      {
        "id": "id",
        "instance_id": "instance_id",
        "score": 0,
        "text": "text",
        "type": "type",
        "item": {
          "key": "key",
          "metadata": {
            "foo": "bar"
          },
          "timestamp": 0
        },
        "scoring_details": {
          "fusion_method": "rrf",
          "keyword_rank": 0,
          "keyword_score": 0,
          "reranking_score": 0,
          "vector_rank": 0,
          "vector_score": 0
        }
      }
    ],
    "search_query": "search_query",
    "errors": [
      {
        "instance_id": "instance_id",
        "message": "message"
      }
    ]
  },
  "success": true
}
```

## Multi-Instance Chat Completions

`client.aiSearch.namespaces.chatCompletions(stringname, NamespaceChatCompletionsParamsparams, RequestOptionsoptions?): NamespaceChatCompletionsResponse`

**post** `/accounts/{account_id}/ai-search/namespaces/{name}/chat/completions`

Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response.

### Parameters

- `name: string`

- `params: NamespaceChatCompletionsParams`

  - `account_id?: string`

    Path param

  - `ai_search_options: AISearchOptions`

    Body param

    - `instance_ids: Array<string>`

    - `cache?: Cache`

      - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

        - `"super_strict_match"`

        - `"close_enough"`

        - `"flexible_friend"`

        - `"anything_goes"`

      - `enabled?: boolean`

    - `query_rewrite?: QueryRewrite`

      - `enabled?: boolean`

      - `model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more`

        - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

        - `"@cf/zai-org/glm-4.7-flash"`

        - `"@cf/meta/llama-3.1-8b-instruct-fast"`

        - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

        - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

        - `"@cf/qwen/qwen3-30b-a3b-fp8"`

        - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

        - `"@cf/moonshotai/kimi-k2-instruct"`

        - `"@cf/google/gemma-3-12b-it"`

        - `"@cf/google/gemma-4-26b-a4b-it"`

        - `"@cf/moonshotai/kimi-k2.5"`

        - `"anthropic/claude-3-7-sonnet"`

        - `"anthropic/claude-sonnet-4"`

        - `"anthropic/claude-opus-4"`

        - `"anthropic/claude-3-5-haiku"`

        - `"cerebras/qwen-3-235b-a22b-instruct"`

        - `"cerebras/qwen-3-235b-a22b-thinking"`

        - `"cerebras/llama-3.3-70b"`

        - `"cerebras/llama-4-maverick-17b-128e-instruct"`

        - `"cerebras/llama-4-scout-17b-16e-instruct"`

        - `"cerebras/gpt-oss-120b"`

        - `"google-ai-studio/gemini-2.5-flash"`

        - `"google-ai-studio/gemini-2.5-pro"`

        - `"grok/grok-4"`

        - `"groq/llama-3.3-70b-versatile"`

        - `"groq/llama-3.1-8b-instant"`

        - `"openai/gpt-5"`

        - `"openai/gpt-5-mini"`

        - `"openai/gpt-5-nano"`

        - `""`

      - `rewrite_prompt?: string`

    - `reranking?: Reranking`

      - `enabled?: boolean`

      - `match_threshold?: number`

      - `model?: "@cf/baai/bge-reranker-base" | ""`

        - `"@cf/baai/bge-reranker-base"`

        - `""`

    - `retrieval?: Retrieval`

      - `boost_by?: Array<BoostBy>`

        Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

        - `field: string`

          Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

        - `direction?: "asc" | "desc" | "exists" | "not_exists"`

          Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

          - `"asc"`

          - `"desc"`

          - `"exists"`

          - `"not_exists"`

      - `context_expansion?: number`

      - `filters?: Record<string, unknown>`

      - `fusion_method?: "max" | "rrf"`

        - `"max"`

        - `"rrf"`

      - `keyword_match_mode?: "and" | "or"`

        Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

        - `"and"`

        - `"or"`

      - `match_threshold?: number`

      - `max_num_results?: number`

      - `retrieval_type?: "vector" | "keyword" | "hybrid"`

        - `"vector"`

        - `"keyword"`

        - `"hybrid"`

      - `return_on_failure?: boolean`

  - `messages: Array<Message>`

    Body param

    - `content: string | null`

    - `role: "system" | "developer" | "user" | 2 more`

      - `"system"`

      - `"developer"`

      - `"user"`

      - `"assistant"`

      - `"tool"`

  - `model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more`

    Body param

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `stream?: boolean`

    Body param

### Returns

- `NamespaceChatCompletionsResponse`

  - `choices: Array<Choice>`

    - `message: Message`

      - `content: string | null`

      - `role: "system" | "developer" | "user" | 2 more`

        - `"system"`

        - `"developer"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

    - `index?: number`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `instance_id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `id?: string`

  - `errors?: Array<Error>`

    - `instance_id: string`

    - `message: string`

  - `model?: string`

  - `object?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.chatCompletions('my-namespace', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
  ai_search_options: { instance_ids: ['my-ai-search'] },
  messages: [{ content: 'content', role: 'system' }],
});

console.log(response.id);
```

#### Response

```json
{
  "choices": [
    {
      "message": {
        "content": "content",
        "role": "system"
      },
      "index": 0
    }
  ],
  "chunks": [
    {
      "id": "id",
      "instance_id": "instance_id",
      "score": 0,
      "text": "text",
      "type": "type",
      "item": {
        "key": "key",
        "metadata": {
          "foo": "bar"
        },
        "timestamp": 0
      },
      "scoring_details": {
        "fusion_method": "rrf",
        "keyword_rank": 0,
        "keyword_score": 0,
        "reranking_score": 0,
        "vector_rank": 0,
        "vector_score": 0
      }
    }
  ],
  "id": "id",
  "errors": [
    {
      "instance_id": "instance_id",
      "message": "message"
    }
  ],
  "model": "model",
  "object": "object"
}
```

## Domain Types

### Namespace List Response

- `NamespaceListResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Namespace Create Response

- `NamespaceCreateResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Namespace Read Response

- `NamespaceReadResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Namespace Update Response

- `NamespaceUpdateResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Namespace Delete Response

- `NamespaceDeleteResponse`

  - `created_at: string`

  - `name: string`

  - `description?: string | null`

    Optional description for the namespace. Max 256 characters.

### Namespace Search Response

- `NamespaceSearchResponse`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `instance_id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `search_query: string`

  - `errors?: Array<Error>`

    - `instance_id: string`

    - `message: string`

### Namespace Chat Completions Response

- `NamespaceChatCompletionsResponse`

  - `choices: Array<Choice>`

    - `message: Message`

      - `content: string | null`

      - `role: "system" | "developer" | "user" | 2 more`

        - `"system"`

        - `"developer"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

    - `index?: number`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `instance_id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `id?: string`

  - `errors?: Array<Error>`

    - `instance_id: string`

    - `message: string`

  - `model?: string`

  - `object?: string`

# Instances

## List instances.

`client.aiSearch.namespaces.instances.list(stringname, InstanceListParamsparams?, RequestOptionsoptions?): V4PagePaginationArray<InstanceListResponse>`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances`

List instances.

### Parameters

- `name: string`

- `params: InstanceListParams`

  - `account_id?: string`

    Path param

  - `namespace?: string | null`

    Query param

  - `order_by?: "created_at"`

    Query param: Order By Column Name

    - `"created_at"`

  - `order_by_direction?: "asc" | "desc"`

    Query param: Order By Direction

    - `"asc"`

    - `"desc"`

  - `page?: number`

    Query param

  - `per_page?: number`

    Query param

  - `search?: string`

    Query param: Search by id

### Returns

- `InstanceListResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const instanceListResponse of client.aiSearch.namespaces.instances.list('my-namespace', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
})) {
  console.log(instanceListResponse.id);
}
```

#### Response

```json
{
  "result": [
    {
      "id": "my-ai-search",
      "created_at": "2019-12-27T18:11:19.117Z",
      "modified_at": "2019-12-27T18:11:19.117Z",
      "ai_gateway_id": "ai_gateway_id",
      "ai_search_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
      "cache": true,
      "cache_threshold": "super_strict_match",
      "chunk_overlap": 0,
      "chunk_size": 64,
      "created_by": "created_by",
      "custom_metadata": [
        {
          "data_type": "text",
          "field_name": "x"
        }
      ],
      "embedding_model": "@cf/qwen/qwen3-embedding-0.6b",
      "enable": true,
      "engine_version": 0,
      "fusion_method": "max",
      "hybrid_search_enabled": true,
      "index_method": {
        "keyword": true,
        "vector": true
      },
      "indexing_options": {
        "keyword_tokenizer": "porter"
      },
      "last_activity": "2019-12-27T18:11:19.117Z",
      "max_num_results": 1,
      "metadata": {
        "created_from_aisearch_wizard": true,
        "search_for_agents": {
          "hostname": "hostname",
          "zone_id": "zone_id",
          "zone_name": "zone_name"
        },
        "worker_domain": "worker_domain"
      },
      "modified_by": "modified_by",
      "namespace": "namespace",
      "paused": true,
      "public_endpoint_id": "public_endpoint_id",
      "public_endpoint_params": {
        "authorized_hosts": [
          "string"
        ],
        "chat_completions_endpoint": {
          "disabled": true
        },
        "enabled": true,
        "mcp": {
          "description": "description",
          "disabled": true
        },
        "rate_limit": {
          "period_ms": 60000,
          "requests": 1,
          "technique": "fixed"
        },
        "search_endpoint": {
          "disabled": true
        }
      },
      "reranking": true,
      "reranking_model": "@cf/baai/bge-reranker-base",
      "retrieval_options": {
        "boost_by": [
          {
            "field": "timestamp",
            "direction": "desc"
          }
        ],
        "keyword_match_mode": "and"
      },
      "rewrite_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
      "rewrite_query": true,
      "score_threshold": 0,
      "source": "source",
      "source_params": {
        "exclude_items": [
          "/admin/**",
          "/private/**",
          "**\\temp\\**"
        ],
        "include_items": [
          "/blog/**",
          "/docs/**/*.html",
          "**\\blog\\**.html"
        ],
        "prefix": "prefix",
        "r2_jurisdiction": "r2_jurisdiction",
        "web_crawler": {
          "crawl_options": {
            "depth": 1,
            "include_external_links": true,
            "include_subdomains": true,
            "max_age": 0,
            "source": "all"
          },
          "parse_options": {
            "content_selector": [
              {
                "path": "**/blog/**",
                "selector": "article .post-body"
              }
            ],
            "include_headers": {
              "foo": "string"
            },
            "include_images": true,
            "specific_sitemaps": [
              "https://example.com/sitemap.xml",
              "https://example.com/blog-sitemap.xml"
            ],
            "use_browser_rendering": true
          },
          "parse_type": "sitemap",
          "store_options": {
            "storage_id": "storage_id",
            "r2_jurisdiction": "r2_jurisdiction",
            "storage_type": "r2"
          }
        }
      },
      "status": "status",
      "sync_interval": 3600,
      "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "type": "r2"
    }
  ],
  "success": true
}
```

## Create new instances.

`client.aiSearch.namespaces.instances.create(stringname, InstanceCreateParamsparams, RequestOptionsoptions?): InstanceCreateResponse`

**post** `/accounts/{account_id}/ai-search/namespaces/{name}/instances`

Create a new instances.

### Parameters

- `name: string`

- `params: InstanceCreateParams`

  - `account_id?: string`

    Path param

  - `id: string`

    Body param: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `ai_gateway_id?: string | null`

    Body param

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    Body param

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

    Body param

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    Body param

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk?: boolean`

    Body param

  - `chunk_overlap?: number`

    Body param

  - `chunk_size?: number`

    Body param

  - `custom_metadata?: Array<CustomMetadata>`

    Body param

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    Body param

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `fusion_method?: "max" | "rrf"`

    Body param

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Body param: Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Body param: Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    Body param

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `max_num_results?: number`

    Body param

  - `metadata?: Metadata`

    Body param

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `public_endpoint_params?: PublicEndpointParams`

    Body param

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

    Body param

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    Body param

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    Body param

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    Body param

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

    Body param

  - `score_threshold?: number`

    Body param

  - `source?: string | null`

    Body param

  - `source_params?: SourceParams | null`

    Body param

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Body param: Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

    Body param

  - `type?: "r2" | "web-crawler" | null`

    Body param

    - `"r2"`

    - `"web-crawler"`

### Returns

- `InstanceCreateResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const instance = await client.aiSearch.namespaces.instances.create('my-namespace', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
  id: 'my-ai-search',
});

console.log(instance.id);
```

#### Response

```json
{
  "result": {
    "id": "my-ai-search",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "ai_gateway_id": "ai_gateway_id",
    "ai_search_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "cache": true,
    "cache_threshold": "super_strict_match",
    "chunk_overlap": 0,
    "chunk_size": 64,
    "created_by": "created_by",
    "custom_metadata": [
      {
        "data_type": "text",
        "field_name": "x"
      }
    ],
    "embedding_model": "@cf/qwen/qwen3-embedding-0.6b",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 1,
    "metadata": {
      "created_from_aisearch_wizard": true,
      "search_for_agents": {
        "hostname": "hostname",
        "zone_id": "zone_id",
        "zone_name": "zone_name"
      },
      "worker_domain": "worker_domain"
    },
    "modified_by": "modified_by",
    "namespace": "namespace",
    "paused": true,
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "@cf/baai/bge-reranker-base",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "rewrite_query": true,
    "score_threshold": 0,
    "source": "source",
    "source_params": {
      "exclude_items": [
        "/admin/**",
        "/private/**",
        "**\\temp\\**"
      ],
      "include_items": [
        "/blog/**",
        "/docs/**/*.html",
        "**\\blog\\**.html"
      ],
      "prefix": "prefix",
      "r2_jurisdiction": "r2_jurisdiction",
      "web_crawler": {
        "crawl_options": {
          "depth": 1,
          "include_external_links": true,
          "include_subdomains": true,
          "max_age": 0,
          "source": "all"
        },
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article .post-body"
            }
          ],
          "include_headers": {
            "foo": "string"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap",
        "store_options": {
          "storage_id": "storage_id",
          "r2_jurisdiction": "r2_jurisdiction",
          "storage_type": "r2"
        }
      }
    },
    "status": "status",
    "sync_interval": 3600,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}
```

## Read instances.

`client.aiSearch.namespaces.instances.read(stringname, stringid, InstanceReadParamsparams?, RequestOptionsoptions?): InstanceReadResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}`

Read instances.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: InstanceReadParams`

  - `account_id?: string`

### Returns

- `InstanceReadResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.read('my-namespace', 'my-ai-search', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(response.id);
```

#### Response

```json
{
  "result": {
    "id": "my-ai-search",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "ai_gateway_id": "ai_gateway_id",
    "ai_search_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "cache": true,
    "cache_threshold": "super_strict_match",
    "chunk_overlap": 0,
    "chunk_size": 64,
    "created_by": "created_by",
    "custom_metadata": [
      {
        "data_type": "text",
        "field_name": "x"
      }
    ],
    "embedding_model": "@cf/qwen/qwen3-embedding-0.6b",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 1,
    "metadata": {
      "created_from_aisearch_wizard": true,
      "search_for_agents": {
        "hostname": "hostname",
        "zone_id": "zone_id",
        "zone_name": "zone_name"
      },
      "worker_domain": "worker_domain"
    },
    "modified_by": "modified_by",
    "namespace": "namespace",
    "paused": true,
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "@cf/baai/bge-reranker-base",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "rewrite_query": true,
    "score_threshold": 0,
    "source": "source",
    "source_params": {
      "exclude_items": [
        "/admin/**",
        "/private/**",
        "**\\temp\\**"
      ],
      "include_items": [
        "/blog/**",
        "/docs/**/*.html",
        "**\\blog\\**.html"
      ],
      "prefix": "prefix",
      "r2_jurisdiction": "r2_jurisdiction",
      "web_crawler": {
        "crawl_options": {
          "depth": 1,
          "include_external_links": true,
          "include_subdomains": true,
          "max_age": 0,
          "source": "all"
        },
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article .post-body"
            }
          ],
          "include_headers": {
            "foo": "string"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap",
        "store_options": {
          "storage_id": "storage_id",
          "r2_jurisdiction": "r2_jurisdiction",
          "storage_type": "r2"
        }
      }
    },
    "status": "status",
    "sync_interval": 3600,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}
```

## Update instances.

`client.aiSearch.namespaces.instances.update(stringname, stringid, InstanceUpdateParamsparams?, RequestOptionsoptions?): InstanceUpdateResponse`

**put** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}`

Update instances.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: InstanceUpdateParams`

  - `account_id?: string`

    Path param

  - `ai_gateway_id?: string | null`

    Body param

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    Body param

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

    Body param

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    Body param

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk?: boolean`

    Body param

  - `chunk_overlap?: number`

    Body param

  - `chunk_size?: number`

    Body param

  - `custom_metadata?: Array<CustomMetadata>`

    Body param

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    Body param

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `fusion_method?: "max" | "rrf"`

    Body param

    - `"max"`

    - `"rrf"`

  - `index_method?: IndexMethod`

    Body param: Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    Body param

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `max_num_results?: number`

    Body param

  - `metadata?: Metadata`

    Body param

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `paused?: boolean`

    Body param

  - `public_endpoint_params?: PublicEndpointParams`

    Body param

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

    Body param

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    Body param

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    Body param

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    Body param

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

    Body param

  - `score_threshold?: number`

    Body param

  - `source_params?: SourceParams | null`

    Body param

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `summarization?: boolean`

    Body param

  - `summarization_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    Body param

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Body param: Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `system_prompt_ai_search?: string | null`

    Body param

  - `system_prompt_index_summarization?: string | null`

    Body param

  - `system_prompt_rewrite_query?: string | null`

    Body param

  - `token_id?: string`

    Body param

### Returns

- `InstanceUpdateResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const instance = await client.aiSearch.namespaces.instances.update('my-namespace', 'my-ai-search', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(instance.id);
```

#### Response

```json
{
  "result": {
    "id": "my-ai-search",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "ai_gateway_id": "ai_gateway_id",
    "ai_search_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "cache": true,
    "cache_threshold": "super_strict_match",
    "chunk_overlap": 0,
    "chunk_size": 64,
    "created_by": "created_by",
    "custom_metadata": [
      {
        "data_type": "text",
        "field_name": "x"
      }
    ],
    "embedding_model": "@cf/qwen/qwen3-embedding-0.6b",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 1,
    "metadata": {
      "created_from_aisearch_wizard": true,
      "search_for_agents": {
        "hostname": "hostname",
        "zone_id": "zone_id",
        "zone_name": "zone_name"
      },
      "worker_domain": "worker_domain"
    },
    "modified_by": "modified_by",
    "namespace": "namespace",
    "paused": true,
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "@cf/baai/bge-reranker-base",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "rewrite_query": true,
    "score_threshold": 0,
    "source": "source",
    "source_params": {
      "exclude_items": [
        "/admin/**",
        "/private/**",
        "**\\temp\\**"
      ],
      "include_items": [
        "/blog/**",
        "/docs/**/*.html",
        "**\\blog\\**.html"
      ],
      "prefix": "prefix",
      "r2_jurisdiction": "r2_jurisdiction",
      "web_crawler": {
        "crawl_options": {
          "depth": 1,
          "include_external_links": true,
          "include_subdomains": true,
          "max_age": 0,
          "source": "all"
        },
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article .post-body"
            }
          ],
          "include_headers": {
            "foo": "string"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap",
        "store_options": {
          "storage_id": "storage_id",
          "r2_jurisdiction": "r2_jurisdiction",
          "storage_type": "r2"
        }
      }
    },
    "status": "status",
    "sync_interval": 3600,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}
```

## Delete instances.

`client.aiSearch.namespaces.instances.delete(stringname, stringid, InstanceDeleteParamsparams?, RequestOptionsoptions?): InstanceDeleteResponse`

**delete** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}`

Delete instances.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: InstanceDeleteParams`

  - `account_id?: string`

### Returns

- `InstanceDeleteResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const instance = await client.aiSearch.namespaces.instances.delete('my-namespace', 'my-ai-search', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(instance.id);
```

#### Response

```json
{
  "result": {
    "id": "my-ai-search",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "ai_gateway_id": "ai_gateway_id",
    "ai_search_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "cache": true,
    "cache_threshold": "super_strict_match",
    "chunk_overlap": 0,
    "chunk_size": 64,
    "created_by": "created_by",
    "custom_metadata": [
      {
        "data_type": "text",
        "field_name": "x"
      }
    ],
    "embedding_model": "@cf/qwen/qwen3-embedding-0.6b",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 1,
    "metadata": {
      "created_from_aisearch_wizard": true,
      "search_for_agents": {
        "hostname": "hostname",
        "zone_id": "zone_id",
        "zone_name": "zone_name"
      },
      "worker_domain": "worker_domain"
    },
    "modified_by": "modified_by",
    "namespace": "namespace",
    "paused": true,
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "@cf/baai/bge-reranker-base",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "rewrite_query": true,
    "score_threshold": 0,
    "source": "source",
    "source_params": {
      "exclude_items": [
        "/admin/**",
        "/private/**",
        "**\\temp\\**"
      ],
      "include_items": [
        "/blog/**",
        "/docs/**/*.html",
        "**\\blog\\**.html"
      ],
      "prefix": "prefix",
      "r2_jurisdiction": "r2_jurisdiction",
      "web_crawler": {
        "crawl_options": {
          "depth": 1,
          "include_external_links": true,
          "include_subdomains": true,
          "max_age": 0,
          "source": "all"
        },
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article .post-body"
            }
          ],
          "include_headers": {
            "foo": "string"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap",
        "store_options": {
          "storage_id": "storage_id",
          "r2_jurisdiction": "r2_jurisdiction",
          "storage_type": "r2"
        }
      }
    },
    "status": "status",
    "sync_interval": 3600,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}
```

## Stats

`client.aiSearch.namespaces.instances.stats(stringname, stringid, InstanceStatsParamsparams?, RequestOptionsoptions?): InstanceStatsResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats`

Retrieves usage statistics for AI Search instances.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: InstanceStatsParams`

  - `account_id?: string`

### Returns

- `InstanceStatsResponse`

  - `completed?: number`

  - `engine?: Engine`

    Engine-specific metadata. Present only for managed (v3) instances.

    - `r2?: R2`

      R2 bucket storage usage in bytes.

      - `metadataSizeBytes: number`

      - `objectCount: number`

      - `payloadSizeBytes: number`

    - `vectorize?: Vectorize`

      Vectorize index metadata (dimensions, vector count).

      - `dimensions: number`

      - `vectorsCount: number`

  - `error?: number`

  - `file_embed_errors?: Record<string, unknown>`

  - `index_source_errors?: Record<string, unknown>`

  - `last_activity?: string`

  - `outdated?: number`

  - `queued?: number`

  - `running?: number`

  - `skipped?: number`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.stats('my-namespace', 'my-ai-search', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(response.completed);
```

#### Response

```json
{
  "result": {
    "completed": 0,
    "engine": {
      "r2": {
        "metadataSizeBytes": 0,
        "objectCount": 0,
        "payloadSizeBytes": 0
      },
      "vectorize": {
        "dimensions": 0,
        "vectorsCount": 0
      }
    },
    "error": 0,
    "file_embed_errors": {
      "foo": "bar"
    },
    "index_source_errors": {
      "foo": "bar"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "outdated": 0,
    "queued": 0,
    "running": 0,
    "skipped": 0
  },
  "success": true
}
```

## Search

`client.aiSearch.namespaces.instances.search(stringname, stringid, InstanceSearchParamsparams?, RequestOptionsoptions?): InstanceSearchResponse`

**post** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search`

Executes a semantic search query against an AI Search instance to find relevant indexed content.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: InstanceSearchParams`

  - `account_id?: string`

    Path param

  - `ai_search_options?: AISearchOptions`

    Body param

    - `cache?: Cache`

      - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

        - `"super_strict_match"`

        - `"close_enough"`

        - `"flexible_friend"`

        - `"anything_goes"`

      - `enabled?: boolean`

    - `query_rewrite?: QueryRewrite`

      - `enabled?: boolean`

      - `model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more`

        - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

        - `"@cf/zai-org/glm-4.7-flash"`

        - `"@cf/meta/llama-3.1-8b-instruct-fast"`

        - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

        - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

        - `"@cf/qwen/qwen3-30b-a3b-fp8"`

        - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

        - `"@cf/moonshotai/kimi-k2-instruct"`

        - `"@cf/google/gemma-3-12b-it"`

        - `"@cf/google/gemma-4-26b-a4b-it"`

        - `"@cf/moonshotai/kimi-k2.5"`

        - `"anthropic/claude-3-7-sonnet"`

        - `"anthropic/claude-sonnet-4"`

        - `"anthropic/claude-opus-4"`

        - `"anthropic/claude-3-5-haiku"`

        - `"cerebras/qwen-3-235b-a22b-instruct"`

        - `"cerebras/qwen-3-235b-a22b-thinking"`

        - `"cerebras/llama-3.3-70b"`

        - `"cerebras/llama-4-maverick-17b-128e-instruct"`

        - `"cerebras/llama-4-scout-17b-16e-instruct"`

        - `"cerebras/gpt-oss-120b"`

        - `"google-ai-studio/gemini-2.5-flash"`

        - `"google-ai-studio/gemini-2.5-pro"`

        - `"grok/grok-4"`

        - `"groq/llama-3.3-70b-versatile"`

        - `"groq/llama-3.1-8b-instant"`

        - `"openai/gpt-5"`

        - `"openai/gpt-5-mini"`

        - `"openai/gpt-5-nano"`

        - `""`

      - `rewrite_prompt?: string`

    - `reranking?: Reranking`

      - `enabled?: boolean`

      - `match_threshold?: number`

      - `model?: "@cf/baai/bge-reranker-base" | ""`

        - `"@cf/baai/bge-reranker-base"`

        - `""`

    - `retrieval?: Retrieval`

      - `boost_by?: Array<BoostBy>`

        Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

        - `field: string`

          Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

        - `direction?: "asc" | "desc" | "exists" | "not_exists"`

          Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

          - `"asc"`

          - `"desc"`

          - `"exists"`

          - `"not_exists"`

      - `context_expansion?: number`

      - `filters?: Record<string, unknown>`

      - `fusion_method?: "max" | "rrf"`

        - `"max"`

        - `"rrf"`

      - `keyword_match_mode?: "and" | "or"`

        Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

        - `"and"`

        - `"or"`

      - `match_threshold?: number`

      - `max_num_results?: number`

      - `retrieval_type?: "vector" | "keyword" | "hybrid"`

        - `"vector"`

        - `"keyword"`

        - `"hybrid"`

      - `return_on_failure?: boolean`

  - `messages?: Array<Message>`

    Body param

    - `content: string | null`

    - `role: "system" | "developer" | "user" | 2 more`

      - `"system"`

      - `"developer"`

      - `"user"`

      - `"assistant"`

      - `"tool"`

  - `query?: string`

    Body param: A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both.

### Returns

- `InstanceSearchResponse`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `search_query: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.search('my-namespace', 'my-ai-search', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(response.chunks);
```

#### Response

```json
{
  "result": {
    "chunks": [
      {
        "id": "id",
        "score": 0,
        "text": "text",
        "type": "type",
        "item": {
          "key": "key",
          "metadata": {
            "foo": "bar"
          },
          "timestamp": 0
        },
        "scoring_details": {
          "fusion_method": "rrf",
          "keyword_rank": 0,
          "keyword_score": 0,
          "reranking_score": 0,
          "vector_rank": 0,
          "vector_score": 0
        }
      }
    ],
    "search_query": "search_query"
  },
  "success": true
}
```

## Chat Completions

`client.aiSearch.namespaces.instances.chatCompletions(stringname, stringid, InstanceChatCompletionsParamsparams, RequestOptionsoptions?): InstanceChatCompletionsResponse`

**post** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions`

Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: InstanceChatCompletionsParams`

  - `account_id?: string`

    Path param

  - `messages: Array<Message>`

    Body param

    - `content: string | null`

    - `role: "system" | "developer" | "user" | 2 more`

      - `"system"`

      - `"developer"`

      - `"user"`

      - `"assistant"`

      - `"tool"`

  - `ai_search_options?: AISearchOptions`

    Body param

    - `cache?: Cache`

      - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

        - `"super_strict_match"`

        - `"close_enough"`

        - `"flexible_friend"`

        - `"anything_goes"`

      - `enabled?: boolean`

    - `query_rewrite?: QueryRewrite`

      - `enabled?: boolean`

      - `model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more`

        - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

        - `"@cf/zai-org/glm-4.7-flash"`

        - `"@cf/meta/llama-3.1-8b-instruct-fast"`

        - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

        - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

        - `"@cf/qwen/qwen3-30b-a3b-fp8"`

        - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

        - `"@cf/moonshotai/kimi-k2-instruct"`

        - `"@cf/google/gemma-3-12b-it"`

        - `"@cf/google/gemma-4-26b-a4b-it"`

        - `"@cf/moonshotai/kimi-k2.5"`

        - `"anthropic/claude-3-7-sonnet"`

        - `"anthropic/claude-sonnet-4"`

        - `"anthropic/claude-opus-4"`

        - `"anthropic/claude-3-5-haiku"`

        - `"cerebras/qwen-3-235b-a22b-instruct"`

        - `"cerebras/qwen-3-235b-a22b-thinking"`

        - `"cerebras/llama-3.3-70b"`

        - `"cerebras/llama-4-maverick-17b-128e-instruct"`

        - `"cerebras/llama-4-scout-17b-16e-instruct"`

        - `"cerebras/gpt-oss-120b"`

        - `"google-ai-studio/gemini-2.5-flash"`

        - `"google-ai-studio/gemini-2.5-pro"`

        - `"grok/grok-4"`

        - `"groq/llama-3.3-70b-versatile"`

        - `"groq/llama-3.1-8b-instant"`

        - `"openai/gpt-5"`

        - `"openai/gpt-5-mini"`

        - `"openai/gpt-5-nano"`

        - `""`

      - `rewrite_prompt?: string`

    - `reranking?: Reranking`

      - `enabled?: boolean`

      - `match_threshold?: number`

      - `model?: "@cf/baai/bge-reranker-base" | ""`

        - `"@cf/baai/bge-reranker-base"`

        - `""`

    - `retrieval?: Retrieval`

      - `boost_by?: Array<BoostBy>`

        Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

        - `field: string`

          Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

        - `direction?: "asc" | "desc" | "exists" | "not_exists"`

          Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

          - `"asc"`

          - `"desc"`

          - `"exists"`

          - `"not_exists"`

      - `context_expansion?: number`

      - `filters?: Record<string, unknown>`

      - `fusion_method?: "max" | "rrf"`

        - `"max"`

        - `"rrf"`

      - `keyword_match_mode?: "and" | "or"`

        Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

        - `"and"`

        - `"or"`

      - `match_threshold?: number`

      - `max_num_results?: number`

      - `retrieval_type?: "vector" | "keyword" | "hybrid"`

        - `"vector"`

        - `"keyword"`

        - `"hybrid"`

      - `return_on_failure?: boolean`

  - `model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more`

    Body param

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `stream?: boolean`

    Body param

### Returns

- `InstanceChatCompletionsResponse`

  - `choices: Array<Choice>`

    - `message: Message`

      - `content: string | null`

      - `role: "system" | "developer" | "user" | 2 more`

        - `"system"`

        - `"developer"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

    - `index?: number`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `id?: string`

  - `model?: string`

  - `object?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.chatCompletions(
  'my-namespace',
  'my-ai-search',
  {
    account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
    messages: [{ content: 'content', role: 'system' }],
  },
);

console.log(response.id);
```

#### Response

```json
{
  "choices": [
    {
      "message": {
        "content": "content",
        "role": "system"
      },
      "index": 0
    }
  ],
  "chunks": [
    {
      "id": "id",
      "score": 0,
      "text": "text",
      "type": "type",
      "item": {
        "key": "key",
        "metadata": {
          "foo": "bar"
        },
        "timestamp": 0
      },
      "scoring_details": {
        "fusion_method": "rrf",
        "keyword_rank": 0,
        "keyword_score": 0,
        "reranking_score": 0,
        "vector_rank": 0,
        "vector_score": 0
      }
    }
  ],
  "id": "id",
  "model": "model",
  "object": "object"
}
```

## Domain Types

### Instance List Response

- `InstanceListResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Instance Create Response

- `InstanceCreateResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Instance Read Response

- `InstanceReadResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Instance Update Response

- `InstanceUpdateResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Instance Delete Response

- `InstanceDeleteResponse`

  - `id: string`

    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

  - `created_at: string`

  - `modified_at: string`

  - `ai_gateway_id?: string | null`

  - `ai_search_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `cache?: boolean`

  - `cache_threshold?: "super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes"`

    - `"super_strict_match"`

    - `"close_enough"`

    - `"flexible_friend"`

    - `"anything_goes"`

  - `chunk_overlap?: number`

  - `chunk_size?: number`

  - `created_by?: string | null`

  - `custom_metadata?: Array<CustomMetadata>`

    - `data_type: "text" | "number" | "boolean" | "datetime"`

      - `"text"`

      - `"number"`

      - `"boolean"`

      - `"datetime"`

    - `field_name: string`

  - `embedding_model?: "@cf/qwen/qwen3-embedding-0.6b" | "@cf/baai/bge-m3" | "@cf/baai/bge-large-en-v1.5" | 6 more | null`

    - `"@cf/qwen/qwen3-embedding-0.6b"`

    - `"@cf/baai/bge-m3"`

    - `"@cf/baai/bge-large-en-v1.5"`

    - `"@cf/google/embeddinggemma-300m"`

    - `"google-ai-studio/gemini-embedding-001"`

    - `"google-ai-studio/gemini-embedding-2-preview"`

    - `"openai/text-embedding-3-small"`

    - `"openai/text-embedding-3-large"`

    - `""`

  - `enable?: boolean`

  - `engine_version?: number`

  - `fusion_method?: "max" | "rrf"`

    - `"max"`

    - `"rrf"`

  - `hybrid_search_enabled?: boolean`

    Deprecated — use index_method instead.

  - `index_method?: IndexMethod`

    Controls which storage backends are used during indexing. Defaults to vector-only.

    - `keyword: boolean`

      Enable keyword (BM25) storage backend.

    - `vector: boolean`

      Enable vector (embedding) storage backend.

  - `indexing_options?: IndexingOptions | null`

    - `keyword_tokenizer?: "porter" | "trigram"`

      Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

      - `"porter"`

      - `"trigram"`

  - `last_activity?: string | null`

  - `max_num_results?: number`

  - `metadata?: Metadata`

    - `created_from_aisearch_wizard?: boolean`

    - `search_for_agents?: SearchForAgents`

      - `hostname: string`

      - `zone_id: string`

      - `zone_name: string`

    - `worker_domain?: string`

  - `modified_by?: string | null`

  - `namespace?: string | null`

  - `paused?: boolean`

  - `public_endpoint_id?: string | null`

  - `public_endpoint_params?: PublicEndpointParams`

    - `authorized_hosts?: Array<string>`

    - `chat_completions_endpoint?: ChatCompletionsEndpoint`

      - `disabled?: boolean`

        Disable chat completions endpoint for this public endpoint

    - `enabled?: boolean`

    - `mcp?: Mcp`

      - `description?: string`

      - `disabled?: boolean`

        Disable MCP endpoint for this public endpoint

    - `rate_limit?: RateLimit`

      - `period_ms?: number`

      - `requests?: number`

      - `technique?: "fixed" | "sliding"`

        - `"fixed"`

        - `"sliding"`

    - `search_endpoint?: SearchEndpoint`

      - `disabled?: boolean`

        Disable search endpoint for this public endpoint

  - `reranking?: boolean`

  - `reranking_model?: "@cf/baai/bge-reranker-base" | "" | null`

    - `"@cf/baai/bge-reranker-base"`

    - `""`

  - `retrieval_options?: RetrievalOptions | null`

    - `boost_by?: Array<BoostBy>`

      Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field.

      - `field: string`

        Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists.

      - `direction?: "asc" | "desc" | "exists" | "not_exists"`

        Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields.

        - `"asc"`

        - `"desc"`

        - `"exists"`

        - `"not_exists"`

    - `keyword_match_mode?: "and" | "or"`

      Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'.

      - `"and"`

      - `"or"`

  - `rewrite_model?: "@cf/meta/llama-3.3-70b-instruct-fp8-fast" | "@cf/zai-org/glm-4.7-flash" | "@cf/meta/llama-3.1-8b-instruct-fast" | 27 more | null`

    - `"@cf/meta/llama-3.3-70b-instruct-fp8-fast"`

    - `"@cf/zai-org/glm-4.7-flash"`

    - `"@cf/meta/llama-3.1-8b-instruct-fast"`

    - `"@cf/meta/llama-3.1-8b-instruct-fp8"`

    - `"@cf/meta/llama-4-scout-17b-16e-instruct"`

    - `"@cf/qwen/qwen3-30b-a3b-fp8"`

    - `"@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"`

    - `"@cf/moonshotai/kimi-k2-instruct"`

    - `"@cf/google/gemma-3-12b-it"`

    - `"@cf/google/gemma-4-26b-a4b-it"`

    - `"@cf/moonshotai/kimi-k2.5"`

    - `"anthropic/claude-3-7-sonnet"`

    - `"anthropic/claude-sonnet-4"`

    - `"anthropic/claude-opus-4"`

    - `"anthropic/claude-3-5-haiku"`

    - `"cerebras/qwen-3-235b-a22b-instruct"`

    - `"cerebras/qwen-3-235b-a22b-thinking"`

    - `"cerebras/llama-3.3-70b"`

    - `"cerebras/llama-4-maverick-17b-128e-instruct"`

    - `"cerebras/llama-4-scout-17b-16e-instruct"`

    - `"cerebras/gpt-oss-120b"`

    - `"google-ai-studio/gemini-2.5-flash"`

    - `"google-ai-studio/gemini-2.5-pro"`

    - `"grok/grok-4"`

    - `"groq/llama-3.3-70b-versatile"`

    - `"groq/llama-3.1-8b-instant"`

    - `"openai/gpt-5"`

    - `"openai/gpt-5-mini"`

    - `"openai/gpt-5-nano"`

    - `""`

  - `rewrite_query?: boolean`

  - `score_threshold?: number`

  - `source?: string | null`

  - `source_params?: SourceParams | null`

    - `exclude_items?: Array<string>`

      List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)

    - `include_items?: Array<string>`

      List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)

    - `prefix?: string`

    - `r2_jurisdiction?: string`

    - `web_crawler?: WebCrawler`

      - `crawl_options?: CrawlOptions`

        - `depth?: number`

        - `include_external_links?: boolean`

        - `include_subdomains?: boolean`

        - `max_age?: number`

        - `source?: "all" | "sitemaps" | "links"`

          - `"all"`

          - `"sitemaps"`

          - `"links"`

      - `parse_options?: ParseOptions`

        - `content_selector?: Array<ContentSelector>`

          List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed.

          - `path: string`

            Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

          - `selector: string`

            CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

        - `include_headers?: Record<string, string>`

        - `include_images?: boolean`

        - `specific_sitemaps?: Array<string>`

          List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

        - `use_browser_rendering?: boolean`

      - `parse_type?: "sitemap" | "feed-rss" | "crawl"`

        - `"sitemap"`

        - `"feed-rss"`

        - `"crawl"`

      - `store_options?: StoreOptions`

        - `storage_id: string`

        - `r2_jurisdiction?: string`

        - `storage_type?: Provider`

          - `"r2"`

  - `status?: string`

  - `sync_interval?: 3600 | 7200 | 14400 | 3 more`

    Interval between automatic syncs, in seconds. Allowed values: 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

    - `3600`

    - `7200`

    - `14400`

    - `21600`

    - `43200`

    - `86400`

  - `token_id?: string`

  - `type?: "r2" | "web-crawler" | null`

    - `"r2"`

    - `"web-crawler"`

### Instance Stats Response

- `InstanceStatsResponse`

  - `completed?: number`

  - `engine?: Engine`

    Engine-specific metadata. Present only for managed (v3) instances.

    - `r2?: R2`

      R2 bucket storage usage in bytes.

      - `metadataSizeBytes: number`

      - `objectCount: number`

      - `payloadSizeBytes: number`

    - `vectorize?: Vectorize`

      Vectorize index metadata (dimensions, vector count).

      - `dimensions: number`

      - `vectorsCount: number`

  - `error?: number`

  - `file_embed_errors?: Record<string, unknown>`

  - `index_source_errors?: Record<string, unknown>`

  - `last_activity?: string`

  - `outdated?: number`

  - `queued?: number`

  - `running?: number`

  - `skipped?: number`

### Instance Search Response

- `InstanceSearchResponse`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `search_query: string`

### Instance Chat Completions Response

- `InstanceChatCompletionsResponse`

  - `choices: Array<Choice>`

    - `message: Message`

      - `content: string | null`

      - `role: "system" | "developer" | "user" | 2 more`

        - `"system"`

        - `"developer"`

        - `"user"`

        - `"assistant"`

        - `"tool"`

    - `index?: number`

  - `chunks: Array<Chunk>`

    - `id: string`

    - `score: number`

    - `text: string`

    - `type: string`

    - `item?: Item`

      - `key: string`

      - `metadata?: Record<string, unknown>`

      - `timestamp?: number`

    - `scoring_details?: ScoringDetails`

      - `fusion_method?: "rrf" | "max"`

        - `"rrf"`

        - `"max"`

      - `keyword_rank?: number`

      - `keyword_score?: number`

      - `reranking_score?: number`

      - `vector_rank?: number`

      - `vector_score?: number`

  - `id?: string`

  - `model?: string`

  - `object?: string`

# Jobs

## List Jobs

`client.aiSearch.namespaces.instances.jobs.list(stringname, stringid, JobListParamsparams?, RequestOptionsoptions?): V4PagePaginationArray<JobListResponse>`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs`

Lists indexing jobs for an AI Search instance.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: JobListParams`

  - `account_id?: string`

    Path param

  - `page?: number`

    Query param

  - `per_page?: number`

    Query param

### Returns

- `JobListResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const jobListResponse of client.aiSearch.namespaces.instances.jobs.list(
  'my-namespace',
  'my-ai-search',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
)) {
  console.log(jobListResponse.id);
}
```

#### Response

```json
{
  "result": [
    {
      "id": "id",
      "source": "user",
      "description": "description",
      "end_reason": "end_reason",
      "ended_at": "ended_at",
      "last_seen_at": "last_seen_at",
      "started_at": "started_at"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}
```

## Create new job

`client.aiSearch.namespaces.instances.jobs.create(stringname, stringid, JobCreateParamsparams?, RequestOptionsoptions?): JobCreateResponse`

**post** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs`

Creates a new indexing job for an AI Search instance.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: JobCreateParams`

  - `account_id?: string`

    Path param

  - `description?: string`

    Body param

### Returns

- `JobCreateResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const job = await client.aiSearch.namespaces.instances.jobs.create('my-namespace', 'my-ai-search', {
  account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
});

console.log(job.id);
```

#### Response

```json
{
  "result": {
    "id": "id",
    "source": "user",
    "description": "description",
    "end_reason": "end_reason",
    "ended_at": "ended_at",
    "last_seen_at": "last_seen_at",
    "started_at": "started_at"
  },
  "success": true
}
```

## Get a Job Details

`client.aiSearch.namespaces.instances.jobs.get(stringname, stringid, stringjobId, JobGetParamsparams?, RequestOptionsoptions?): JobGetResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}`

Retrieves details for a specific AI Search indexing job.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `jobId: string`

- `params: JobGetParams`

  - `account_id?: string`

### Returns

- `JobGetResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const job = await client.aiSearch.namespaces.instances.jobs.get(
  'my-namespace',
  'my-ai-search',
  'job_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
);

console.log(job.id);
```

#### Response

```json
{
  "result": {
    "id": "id",
    "source": "user",
    "description": "description",
    "end_reason": "end_reason",
    "ended_at": "ended_at",
    "last_seen_at": "last_seen_at",
    "started_at": "started_at"
  },
  "success": true
}
```

## Change Job Status

`client.aiSearch.namespaces.instances.jobs.update(stringname, stringid, stringjobId, JobUpdateParamsparams, RequestOptionsoptions?): JobUpdateResponse`

**patch** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}`

Updates the status of an AI Search indexing job.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `jobId: string`

- `params: JobUpdateParams`

  - `account_id?: string`

    Path param

  - `action: "cancel"`

    Body param

    - `"cancel"`

### Returns

- `JobUpdateResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const job = await client.aiSearch.namespaces.instances.jobs.update(
  'my-namespace',
  'my-ai-search',
  'job_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22', action: 'cancel' },
);

console.log(job.id);
```

#### Response

```json
{
  "result": {
    "id": "id",
    "source": "user",
    "description": "description",
    "end_reason": "end_reason",
    "ended_at": "ended_at",
    "last_seen_at": "last_seen_at",
    "started_at": "started_at"
  },
  "success": true
}
```

## List Job Logs

`client.aiSearch.namespaces.instances.jobs.logs(stringname, stringid, stringjobId, JobLogsParamsparams?, RequestOptionsoptions?): JobLogsResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs`

Lists log entries for an AI Search indexing job.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `jobId: string`

- `params: JobLogsParams`

  - `account_id?: string`

    Path param

  - `page?: number`

    Query param

  - `per_page?: number`

    Query param

### Returns

- `JobLogsResponse = Array<JobLogsResponseItem>`

  - `id: number`

  - `created_at: number`

  - `message: string`

  - `message_type: number`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.jobs.logs(
  'my-namespace',
  'my-ai-search',
  'job_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
);

console.log(response);
```

#### Response

```json
{
  "result": [
    {
      "id": 0,
      "created_at": 0,
      "message": "message",
      "message_type": 0
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}
```

## Domain Types

### Job List Response

- `JobListResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Job Create Response

- `JobCreateResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Job Get Response

- `JobGetResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Job Update Response

- `JobUpdateResponse`

  - `id: string`

  - `source: "user" | "schedule"`

    - `"user"`

    - `"schedule"`

  - `description?: string`

  - `end_reason?: string`

  - `ended_at?: string`

  - `last_seen_at?: string`

  - `started_at?: string`

### Job Logs Response

- `JobLogsResponse = Array<JobLogsResponseItem>`

  - `id: number`

  - `created_at: number`

  - `message: string`

  - `message_type: number`

# Items

## Items List.

`client.aiSearch.namespaces.instances.items.list(stringname, stringid, ItemListParamsparams?, RequestOptionsoptions?): V4PagePaginationArray<ItemListResponse>`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items`

Lists indexed items in an AI Search instance.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: ItemListParams`

  - `account_id?: string`

    Path param

  - `metadata_filter?: string`

    Query param: JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}

  - `page?: number`

    Query param

  - `per_page?: number`

    Query param

  - `search?: string`

    Query param

  - `sort_by?: "status" | "modified_at"`

    Query param: Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at.

    - `"status"`

    - `"modified_at"`

  - `source?: string`

    Query param: Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com".

  - `status?: "queued" | "running" | "completed" | 3 more`

    Query param

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

### Returns

- `ItemListResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const itemListResponse of client.aiSearch.namespaces.instances.items.list(
  'my-namespace',
  'my-ai-search',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
)) {
  console.log(itemListResponse.id);
}
```

#### Response

```json
{
  "result": [
    {
      "id": "id",
      "checksum": "checksum",
      "chunks_count": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_size": 0,
      "key": "key",
      "last_seen_at": "2019-12-27T18:11:19.117Z",
      "namespace": "namespace",
      "next_action": "INDEX",
      "source_id": "source_id",
      "status": "queued",
      "error": "error"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "total_count": 0,
    "per_page": 5
  },
  "success": true
}
```

## Upload Item.

`client.aiSearch.namespaces.instances.items.upload(stringname, stringid, ItemUploadParamsparams, RequestOptionsoptions?): ItemUploadResponse`

**post** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items`

Uploads a file to a managed AI Search instance via multipart/form-data (max 4MB).

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: ItemUploadParams`

  - `account_id?: string`

    Path param

  - `file: File`

    Body param

    - `file: Uploadable`

      The file to upload (max 4MB). Filename must not exceed 128 characters.

    - `metadata?: string`

      JSON string of custom metadata key-value pairs.

    - `wait_for_completion?: boolean`

      Wait for indexing to complete before responding. Defaults to false.

### Returns

- `ItemUploadResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.items.upload(
  'my-namespace',
  'my-ai-search',
  {
    account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
    file: { file: fs.createReadStream('path/to/file') },
  },
);

console.log(response.id);
```

#### Response

```json
{
  "result": {
    "id": "id",
    "checksum": "checksum",
    "chunks_count": 0,
    "created_at": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "key": "key",
    "last_seen_at": "2019-12-27T18:11:19.117Z",
    "namespace": "namespace",
    "next_action": "INDEX",
    "source_id": "source_id",
    "status": "queued",
    "error": "error"
  },
  "success": true
}
```

## Create or Update Item.

`client.aiSearch.namespaces.instances.items.createOrUpdate(stringname, stringid, ItemCreateOrUpdateParamsparams, RequestOptionsoptions?): ItemCreateOrUpdateResponse`

**put** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items`

Creates or updates an indexed item in an AI Search instance.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `params: ItemCreateOrUpdateParams`

  - `account_id?: string`

    Path param

  - `key: string`

    Body param: Item key / filename. Must not exceed 128 characters.

  - `next_action: "INDEX"`

    Body param

    - `"INDEX"`

### Returns

- `ItemCreateOrUpdateResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.items.createOrUpdate(
  'my-namespace',
  'my-ai-search',
  {
    account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
    key: 'key',
    next_action: 'INDEX',
  },
);

console.log(response.id);
```

#### Response

```json
{
  "result": {
    "id": "id",
    "checksum": "checksum",
    "chunks_count": 0,
    "created_at": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "key": "key",
    "last_seen_at": "2019-12-27T18:11:19.117Z",
    "namespace": "namespace",
    "next_action": "INDEX",
    "source_id": "source_id",
    "status": "queued",
    "error": "error"
  },
  "success": true
}
```

## Get Item.

`client.aiSearch.namespaces.instances.items.get(stringname, stringid, stringitemId, ItemGetParamsparams?, RequestOptionsoptions?): ItemGetResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}`

Retrieves a specific indexed item from an AI Search instance.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `itemId: string`

- `params: ItemGetParams`

  - `account_id?: string`

### Returns

- `ItemGetResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const item = await client.aiSearch.namespaces.instances.items.get(
  'my-namespace',
  'my-ai-search',
  'item_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
);

console.log(item.id);
```

#### Response

```json
{
  "result": {
    "id": "id",
    "checksum": "checksum",
    "chunks_count": 0,
    "created_at": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "key": "key",
    "last_seen_at": "2019-12-27T18:11:19.117Z",
    "namespace": "namespace",
    "next_action": "INDEX",
    "source_id": "source_id",
    "status": "queued",
    "error": "error"
  },
  "success": true
}
```

## Sync Item.

`client.aiSearch.namespaces.instances.items.sync(stringname, stringid, stringitemId, ItemSyncParamsparams, RequestOptionsoptions?): ItemSyncResponse`

**patch** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}`

Syncs an item to an AI Search instance index.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `itemId: string`

- `params: ItemSyncParams`

  - `account_id?: string`

    Path param

  - `next_action: "INDEX"`

    Body param

    - `"INDEX"`

### Returns

- `ItemSyncResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.items.sync(
  'my-namespace',
  'my-ai-search',
  'item_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22', next_action: 'INDEX' },
);

console.log(response.id);
```

#### Response

```json
{
  "result": {
    "id": "id",
    "checksum": "checksum",
    "chunks_count": 0,
    "created_at": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "key": "key",
    "last_seen_at": "2019-12-27T18:11:19.117Z",
    "namespace": "namespace",
    "next_action": "INDEX",
    "source_id": "source_id",
    "status": "queued",
    "error": "error"
  },
  "success": true
}
```

## Delete Item.

`client.aiSearch.namespaces.instances.items.delete(stringname, stringid, stringitemId, ItemDeleteParamsparams?, RequestOptionsoptions?): ItemDeleteResponse`

**delete** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}`

Deletes a file from a managed AI Search instance and triggers a reindex.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `itemId: string`

- `params: ItemDeleteParams`

  - `account_id?: string`

### Returns

- `ItemDeleteResponse`

  - `key: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const item = await client.aiSearch.namespaces.instances.items.delete(
  'my-namespace',
  'my-ai-search',
  'item_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
);

console.log(item.key);
```

#### Response

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

## Download Item Content.

`client.aiSearch.namespaces.instances.items.download(stringname, stringid, stringitemId, ItemDownloadParamsparams?, RequestOptionsoptions?): Response`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download`

Downloads the raw file content for a specific item from the managed AI Search instance storage.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `itemId: string`

- `params: ItemDownloadParams`

  - `account_id?: string`

### Returns

- `unnamed_schema_11 = Response`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.items.download(
  'my-namespace',
  'my-ai-search',
  'item_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
);

console.log(response);

const content = await response.blob();
console.log(content);
```

## Item Logs.

`client.aiSearch.namespaces.instances.items.logs(stringname, stringid, stringitemId, ItemLogsParamsparams?, RequestOptionsoptions?): ItemLogsResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs`

Lists processing logs for a specific item in an AI Search instance.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `itemId: string`

- `params: ItemLogsParams`

  - `account_id?: string`

    Path param

  - `cursor?: string`

    Query param

  - `limit?: number`

    Query param

### Returns

- `ItemLogsResponse = Array<ItemLogsResponseItem>`

  - `action: string`

  - `chunkCount: number | null`

  - `errorType: string | null`

  - `fileKey: string`

  - `message: string | null`

  - `processingTimeMs: number | null`

  - `timestamp: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.items.logs(
  'my-namespace',
  'my-ai-search',
  'item_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
);

console.log(response);
```

#### Response

```json
{
  "result": [
    {
      "action": "action",
      "chunkCount": 0,
      "errorType": "errorType",
      "fileKey": "fileKey",
      "message": "message",
      "processingTimeMs": 0,
      "timestamp": "2019-12-27T18:11:19.117Z"
    }
  ],
  "result_info": {
    "count": 0,
    "cursor": "cursor",
    "per_page": 0,
    "truncated": true
  },
  "success": true
}
```

## List Item Chunks.

`client.aiSearch.namespaces.instances.items.chunks(stringname, stringid, stringitemId, ItemChunksParamsparams?, RequestOptionsoptions?): ItemChunksResponse`

**get** `/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks`

Lists chunks for a specific item in an AI Search instance, including their text content.

### Parameters

- `name: string`

- `id: string`

  AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

- `itemId: string`

- `params: ItemChunksParams`

  - `account_id?: string`

    Path param

  - `limit?: number`

    Query param

  - `offset?: number`

    Query param

### Returns

- `ItemChunksResponse = Array<ItemChunksResponseItem>`

  - `id: string`

  - `item: Item`

    - `key: string`

    - `metadata?: Record<string, unknown>`

    - `timestamp?: number`

  - `text: string`

  - `end_byte?: number`

  - `start_byte?: number`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiSearch.namespaces.instances.items.chunks(
  'my-namespace',
  'my-ai-search',
  'item_id',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
);

console.log(response);
```

#### Response

```json
{
  "result": [
    {
      "id": "id",
      "item": {
        "key": "key",
        "metadata": {
          "foo": "bar"
        },
        "timestamp": 0
      },
      "text": "text",
      "end_byte": 0,
      "start_byte": 0
    }
  ],
  "result_info": {
    "count": 0,
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "success": true
}
```

## Domain Types

### Item List Response

- `ItemListResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Item Upload Response

- `ItemUploadResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Item Create Or Update Response

- `ItemCreateOrUpdateResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Item Get Response

- `ItemGetResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Item Sync Response

- `ItemSyncResponse`

  - `id: string`

  - `checksum: string`

  - `chunks_count: number | null`

  - `created_at: string`

  - `file_size: number | null`

  - `key: string`

  - `last_seen_at: string`

  - `namespace: string`

  - `next_action: "INDEX" | "DELETE" | null`

    - `"INDEX"`

    - `"DELETE"`

  - `source_id: string | null`

    Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.

  - `status: "queued" | "running" | "completed" | 3 more`

    - `"queued"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"skipped"`

    - `"outdated"`

  - `error?: string`

### Item Delete Response

- `ItemDeleteResponse`

  - `key: string`

### Item Logs Response

- `ItemLogsResponse = Array<ItemLogsResponseItem>`

  - `action: string`

  - `chunkCount: number | null`

  - `errorType: string | null`

  - `fileKey: string`

  - `message: string | null`

  - `processingTimeMs: number | null`

  - `timestamp: string`

### Item Chunks Response

- `ItemChunksResponse = Array<ItemChunksResponseItem>`

  - `id: string`

  - `item: Item`

    - `key: string`

    - `metadata?: Record<string, unknown>`

    - `timestamp?: number`

  - `text: string`

  - `end_byte?: number`

  - `start_byte?: number`