PUT /accounts/{account_id}/ai-search/namespaces/{name}

Update the description and/or the public endpoint configuration of an existing namespace. The default namespace's description cannot be modified, but its public endpoint can.

Servers

Path parameters

Name Type Required Description
name String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
public_endpoint_params Object No
public_endpoint_params.custom_domains[] Array No

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).

public_endpoint_params.chat_completions_endpoint Object No
public_endpoint_params.chat_completions_endpoint.disabled Boolean No

Disable chat completions endpoint for this public endpoint

Default value: false

public_endpoint_params.search_endpoint Object No
public_endpoint_params.search_endpoint.disabled Boolean No

Disable search endpoint for this public endpoint

Default value: false

public_endpoint_params.default_domain_enabled Boolean No

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.

Default value: true

public_endpoint_params.instances_allowed[] Array No

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.

public_endpoint_params.enabled Boolean No

Default value: false

public_endpoint_params.authorized_hosts[] Array No
public_endpoint_params.mcp Object No
public_endpoint_params.mcp.description String No

Default value: "Finds exactly what you're looking for"

public_endpoint_params.mcp.disabled Boolean No

Disable MCP endpoint for this public endpoint

Default value: false

public_endpoint_params.rate_limit Object No
public_endpoint_params.rate_limit.requests Integer No
public_endpoint_params.rate_limit.period_ms Integer No
public_endpoint_params.rate_limit.technique String No

Valid values:

  • "fixed"
  • "sliding"
description String No

Optional description for the namespace. Max 256 characters.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.