Create a namespace

client.aiSearch.namespaces.create(, ?): NamespaceCreateResponse { created_at, name, description, 2 more }

POST/accounts/{account_id}/ai-search/namespaces

Create a namespace for organizing AI Search instances.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params: NamespaceCreateParams { account_id, name, description, public_endpoint_params }

account_id: string

Path param

name: string

Body param

description?: string | null

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

maxLength256

public_endpoint_params?: PublicEndpointParams

Body param

authorized_hosts?: Array<string>

chat_completions_endpoint?: ChatCompletionsEndpoint { disabled }

disabled?: boolean

Disable chat completions endpoint for this public endpoint

custom_domains?: Array<string> | null

Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).

default_domain_enabled?: boolean

When false, the instance is reachable only via a registered custom domain and the default <public_endpoint_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public_endpoint_params is replaced wholesale on update, so resend default_domain_enabled on every update to keep the default host off — omitting it resets to true.

enabled?: boolean

instances_allowed?: Array<string>

Instance IDs exposed through the namespace public endpoint. Empty means nothing is searchable. Every ID must be an existing instance in this namespace, and the list cannot exceed the account’s multi-instance search limit.

mcp?: Mcp { description, disabled }

description?: string

disabled?: boolean

Disable MCP endpoint for this public endpoint

rate_limit?: RateLimit { period_ms, requests, technique }

period_ms?: number

maximum3600000

minimum60000

requests?: number

minimum1

technique?: "fixed" | "sliding"

One of the following:

"fixed"

"sliding"

search_endpoint?: SearchEndpoint { disabled }

disabled?: boolean

Disable search endpoint for this public endpoint

ReturnsExpand Collapse

NamespaceCreateResponse { created_at, name, description, 2 more }

created_at: string

formatdate-time

name: string

description?: string | null

Optional description for the namespace. Max 256 characters.

maxLength256

public_endpoint_id?: string | null

public_endpoint_params?: PublicEndpointParams | null

authorized_hosts?: Array<string>

chat_completions_endpoint?: ChatCompletionsEndpoint { disabled }

disabled?: boolean

Disable chat completions endpoint for this public endpoint

custom_domains?: Array<string> | null

default_domain_enabled?: boolean

enabled?: boolean

instances_allowed?: Array<string>

mcp?: Mcp { description, disabled }

description?: string

disabled?: boolean

Disable MCP endpoint for this public endpoint

rate_limit?: RateLimit { period_ms, requests, technique }

period_ms?: number

maximum3600000

minimum60000

requests?: number

minimum1

technique?: "fixed" | "sliding"

One of the following:

"fixed"

"sliding"

search_endpoint?: SearchEndpoint { disabled }

disabled?: boolean

Disable search endpoint for this public endpoint

Create a namespace

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: 'name',
});

console.log(namespace.public_endpoint_id);

{
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "production",
    "description": "Production environment",
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "custom_domains": [
        "search.example.com"
      ],
      "default_domain_enabled": true,
      "enabled": true,
      "instances_allowed": [
        "docs",
        "blog"
      ],
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    }
  },
  "success": true
}

Returns Examples

{
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "production",
    "description": "Production environment",
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "custom_domains": [
        "search.example.com"
      ],
      "default_domain_enabled": true,
      "enabled": true,
      "instances_allowed": [
        "docs",
        "blog"
      ],
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    }
  },
  "success": true
}