API Reference

AI Search

Namespaces

Instances

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update instance.

client.AISearch.Namespaces.Instances.Update(ctx, name, id, params) (*NamespaceInstanceUpdateResponse, error)

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

Update instance.

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

name string

id string

params NamespaceInstanceUpdateParams

AccountID param.Field[string]

Path param

AIGatewayID param.Field[string]Optional

Body param

AISearchModel param.Field[NamespaceInstanceUpdateParamsAISearchModel]Optional

Body param

const NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceUpdateParamsAISearchModelCfZaiOrgGlm4_7Flash NamespaceInstanceUpdateParamsAISearchModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateParamsAISearchModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceUpdateParamsAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceUpdateParamsAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceUpdateParamsAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceUpdateParamsAISearchModelCfMoonshotaiKimiK2Instruct NamespaceInstanceUpdateParamsAISearchModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceUpdateParamsAISearchModelCfGoogleGemma3_12bIt NamespaceInstanceUpdateParamsAISearchModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceUpdateParamsAISearchModelCfGoogleGemma4_26bA4bIt NamespaceInstanceUpdateParamsAISearchModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceUpdateParamsAISearchModelCfMoonshotaiKimiK2_5 NamespaceInstanceUpdateParamsAISearchModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceUpdateParamsAISearchModelAnthropicClaude3_7Sonnet NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceUpdateParamsAISearchModelAnthropicClaudeSonnet4 NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceUpdateParamsAISearchModelAnthropicClaudeOpus4 NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-opus-4"

const NamespaceInstanceUpdateParamsAISearchModelAnthropicClaude3_5Haiku NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceUpdateParamsAISearchModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceUpdateParamsAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceUpdateParamsAISearchModelCerebrasQwen3_235bA22bThinking NamespaceInstanceUpdateParamsAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceUpdateParamsAISearchModelCerebrasLlama3_3_70b NamespaceInstanceUpdateParamsAISearchModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceUpdateParamsAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateParamsAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceUpdateParamsAISearchModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceUpdateParamsAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateParamsAISearchModelCerebrasGptOSs120b NamespaceInstanceUpdateParamsAISearchModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceUpdateParamsAISearchModelGoogleAIStudioGemini2_5Flash NamespaceInstanceUpdateParamsAISearchModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceUpdateParamsAISearchModelGoogleAIStudioGemini2_5Pro NamespaceInstanceUpdateParamsAISearchModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceUpdateParamsAISearchModelGrokGrok4 NamespaceInstanceUpdateParamsAISearchModel = "grok/grok-4"

const NamespaceInstanceUpdateParamsAISearchModelGroqLlama3_3_70bVersatile NamespaceInstanceUpdateParamsAISearchModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceUpdateParamsAISearchModelGroqLlama3_1_8bInstant NamespaceInstanceUpdateParamsAISearchModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceUpdateParamsAISearchModelOpenAIGpt5 NamespaceInstanceUpdateParamsAISearchModel = "openai/gpt-5"

const NamespaceInstanceUpdateParamsAISearchModelOpenAIGpt5Mini NamespaceInstanceUpdateParamsAISearchModel = "openai/gpt-5-mini"

const NamespaceInstanceUpdateParamsAISearchModelOpenAIGpt5Nano NamespaceInstanceUpdateParamsAISearchModel = "openai/gpt-5-nano"

const NamespaceInstanceUpdateParamsAISearchModelEmpty NamespaceInstanceUpdateParamsAISearchModel = ""

Cache param.Field[bool]Optional

Body param

CacheThreshold param.Field[NamespaceInstanceUpdateParamsCacheThreshold]Optional

Body param

const NamespaceInstanceUpdateParamsCacheThresholdSuperStrictMatch NamespaceInstanceUpdateParamsCacheThreshold = "super_strict_match"

const NamespaceInstanceUpdateParamsCacheThresholdCloseEnough NamespaceInstanceUpdateParamsCacheThreshold = "close_enough"

const NamespaceInstanceUpdateParamsCacheThresholdFlexibleFriend NamespaceInstanceUpdateParamsCacheThreshold = "flexible_friend"

const NamespaceInstanceUpdateParamsCacheThresholdAnythingGoes NamespaceInstanceUpdateParamsCacheThreshold = "anything_goes"

CacheTTL param.Field[NamespaceInstanceUpdateParamsCacheTTL]Optional

Body param: Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const NamespaceInstanceUpdateParamsCacheTTL600 NamespaceInstanceUpdateParamsCacheTTL = 600

const NamespaceInstanceUpdateParamsCacheTTL1800 NamespaceInstanceUpdateParamsCacheTTL = 1800

const NamespaceInstanceUpdateParamsCacheTTL3600 NamespaceInstanceUpdateParamsCacheTTL = 3600

const NamespaceInstanceUpdateParamsCacheTTL7200 NamespaceInstanceUpdateParamsCacheTTL = 7200

const NamespaceInstanceUpdateParamsCacheTTL21600 NamespaceInstanceUpdateParamsCacheTTL = 21600

const NamespaceInstanceUpdateParamsCacheTTL43200 NamespaceInstanceUpdateParamsCacheTTL = 43200

const NamespaceInstanceUpdateParamsCacheTTL86400 NamespaceInstanceUpdateParamsCacheTTL = 86400

const NamespaceInstanceUpdateParamsCacheTTL172800 NamespaceInstanceUpdateParamsCacheTTL = 172800

const NamespaceInstanceUpdateParamsCacheTTL259200 NamespaceInstanceUpdateParamsCacheTTL = 259200

const NamespaceInstanceUpdateParamsCacheTTL518400 NamespaceInstanceUpdateParamsCacheTTL = 518400

Chunk param.Field[bool]Optional

Body param

ChunkOverlap param.Field[int64]Optional

Body param

maximum30

minimum0

ChunkSize param.Field[int64]Optional

Body param

minimum64

CustomMetadata param.Field[[]NamespaceInstanceUpdateParamsCustomMetadata]Optional

Body param

DataType NamespaceInstanceUpdateParamsCustomMetadataDataType

One of the following:

const NamespaceInstanceUpdateParamsCustomMetadataDataTypeText NamespaceInstanceUpdateParamsCustomMetadataDataType = "text"

const NamespaceInstanceUpdateParamsCustomMetadataDataTypeNumber NamespaceInstanceUpdateParamsCustomMetadataDataType = "number"

const NamespaceInstanceUpdateParamsCustomMetadataDataTypeBoolean NamespaceInstanceUpdateParamsCustomMetadataDataType = "boolean"

const NamespaceInstanceUpdateParamsCustomMetadataDataTypeDatetime NamespaceInstanceUpdateParamsCustomMetadataDataType = "datetime"

FieldName string

maxLength64

minLength1

EmbeddingModel param.Field[NamespaceInstanceUpdateParamsEmbeddingModel]Optional

Body param

const NamespaceInstanceUpdateParamsEmbeddingModelCfQwenQwen3Embedding0_6b NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"

const NamespaceInstanceUpdateParamsEmbeddingModelCfQwenQwen3VlEmbedding2b NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/qwen/qwen3-vl-embedding-2b"

const NamespaceInstanceUpdateParamsEmbeddingModelCfBaaiBgeM3 NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/baai/bge-m3"

const NamespaceInstanceUpdateParamsEmbeddingModelCfBaaiBgeLargeEnV1_5 NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/baai/bge-large-en-v1.5"

const NamespaceInstanceUpdateParamsEmbeddingModelCfGoogleEmbeddinggemma300m NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/google/embeddinggemma-300m"

const NamespaceInstanceUpdateParamsEmbeddingModelGoogleAIStudioGeminiEmbedding001 NamespaceInstanceUpdateParamsEmbeddingModel = "google-ai-studio/gemini-embedding-001"

const NamespaceInstanceUpdateParamsEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceUpdateParamsEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"

const NamespaceInstanceUpdateParamsEmbeddingModelOpenAITextEmbedding3Small NamespaceInstanceUpdateParamsEmbeddingModel = "openai/text-embedding-3-small"

const NamespaceInstanceUpdateParamsEmbeddingModelOpenAITextEmbedding3Large NamespaceInstanceUpdateParamsEmbeddingModel = "openai/text-embedding-3-large"

const NamespaceInstanceUpdateParamsEmbeddingModelEmpty NamespaceInstanceUpdateParamsEmbeddingModel = ""

FusionMethod param.Field[NamespaceInstanceUpdateParamsFusionMethod]Optional

Body param

const NamespaceInstanceUpdateParamsFusionMethodMax NamespaceInstanceUpdateParamsFusionMethod = "max"

const NamespaceInstanceUpdateParamsFusionMethodRrf NamespaceInstanceUpdateParamsFusionMethod = "rrf"

IndexMethod param.Field[NamespaceInstanceUpdateParamsIndexMethod]Optional

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

Keyword bool

Enable keyword (BM25) storage backend.

Vector bool

Enable vector (embedding) storage backend.

IndexingOptions param.Field[NamespaceInstanceUpdateParamsIndexingOptions]Optional

Body param

KeywordTokenizer NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizerOptional

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.

One of the following:

const NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizerPorter NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer = "porter"

const NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer = "trigram"

MaxNumResults param.Field[int64]Optional

Body param

maximum50

minimum1

Metadata param.Field[NamespaceInstanceUpdateParamsMetadata]Optional

Body param

CreatedFromAISearchWizard boolOptional

WorkerDomain stringOptional

Paused param.Field[bool]Optional

Body param

PublicEndpointParams param.Field[NamespaceInstanceUpdateParamsPublicEndpointParams]Optional

Body param

AuthorizedHosts []stringOptional

ChatCompletionsEndpoint NamespaceInstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpointOptional

Disabled boolOptional

Disable chat completions endpoint for this public endpoint

Enabled boolOptional

Mcp NamespaceInstanceUpdateParamsPublicEndpointParamsMcpOptional

Description stringOptional

Disabled boolOptional

Disable MCP endpoint for this public endpoint

RateLimit NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitOptional

PeriodMs int64Optional

maximum3600000

minimum60000

Requests int64Optional

minimum1

Technique NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueOptional

One of the following:

const NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueFixed NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "fixed"

const NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "sliding"

SearchEndpoint NamespaceInstanceUpdateParamsPublicEndpointParamsSearchEndpointOptional

Disabled boolOptional

Disable search endpoint for this public endpoint

Reranking param.Field[bool]Optional

Body param

RerankingModel param.Field[NamespaceInstanceUpdateParamsRerankingModel]Optional

Body param

const NamespaceInstanceUpdateParamsRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceUpdateParamsRerankingModel = "@cf/baai/bge-reranker-base"

const NamespaceInstanceUpdateParamsRerankingModelEmpty NamespaceInstanceUpdateParamsRerankingModel = ""

RetrievalOptions param.Field[NamespaceInstanceUpdateParamsRetrievalOptions]Optional

Body param

BoostBy []NamespaceInstanceUpdateParamsRetrievalOptionsBoostByOptional

Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to ‘asc’ for numeric/datetime 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 all four directions (asc, desc, exists, not_exists); text/boolean fields only support exists/not_exists.

maxLength64

minLength1

Direction NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionOptional

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.

One of the following:

const NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionAsc NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "asc"

const NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionDesc NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "desc"

const NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionExists NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "exists"

const NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "not_exists"

KeywordMatchMode NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchModeOptional

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

One of the following:

const NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "and"

const NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchModeOr NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "or"

RewriteModel param.Field[NamespaceInstanceUpdateParamsRewriteModel]Optional

Body param

const NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceUpdateParamsRewriteModelCfZaiOrgGlm4_7Flash NamespaceInstanceUpdateParamsRewriteModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateParamsRewriteModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceUpdateParamsRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceUpdateParamsRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceUpdateParamsRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceUpdateParamsRewriteModelCfMoonshotaiKimiK2Instruct NamespaceInstanceUpdateParamsRewriteModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceUpdateParamsRewriteModelCfGoogleGemma3_12bIt NamespaceInstanceUpdateParamsRewriteModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceUpdateParamsRewriteModelCfGoogleGemma4_26bA4bIt NamespaceInstanceUpdateParamsRewriteModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceUpdateParamsRewriteModelCfMoonshotaiKimiK2_5 NamespaceInstanceUpdateParamsRewriteModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceUpdateParamsRewriteModelAnthropicClaude3_7Sonnet NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceUpdateParamsRewriteModelAnthropicClaudeSonnet4 NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceUpdateParamsRewriteModelAnthropicClaudeOpus4 NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-opus-4"

const NamespaceInstanceUpdateParamsRewriteModelAnthropicClaude3_5Haiku NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceUpdateParamsRewriteModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceUpdateParamsRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceUpdateParamsRewriteModelCerebrasQwen3_235bA22bThinking NamespaceInstanceUpdateParamsRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceUpdateParamsRewriteModelCerebrasLlama3_3_70b NamespaceInstanceUpdateParamsRewriteModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceUpdateParamsRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateParamsRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceUpdateParamsRewriteModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceUpdateParamsRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateParamsRewriteModelCerebrasGptOSs120b NamespaceInstanceUpdateParamsRewriteModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceUpdateParamsRewriteModelGoogleAIStudioGemini2_5Flash NamespaceInstanceUpdateParamsRewriteModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceUpdateParamsRewriteModelGoogleAIStudioGemini2_5Pro NamespaceInstanceUpdateParamsRewriteModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceUpdateParamsRewriteModelGrokGrok4 NamespaceInstanceUpdateParamsRewriteModel = "grok/grok-4"

const NamespaceInstanceUpdateParamsRewriteModelGroqLlama3_3_70bVersatile NamespaceInstanceUpdateParamsRewriteModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceUpdateParamsRewriteModelGroqLlama3_1_8bInstant NamespaceInstanceUpdateParamsRewriteModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceUpdateParamsRewriteModelOpenAIGpt5 NamespaceInstanceUpdateParamsRewriteModel = "openai/gpt-5"

const NamespaceInstanceUpdateParamsRewriteModelOpenAIGpt5Mini NamespaceInstanceUpdateParamsRewriteModel = "openai/gpt-5-mini"

const NamespaceInstanceUpdateParamsRewriteModelOpenAIGpt5Nano NamespaceInstanceUpdateParamsRewriteModel = "openai/gpt-5-nano"

const NamespaceInstanceUpdateParamsRewriteModelEmpty NamespaceInstanceUpdateParamsRewriteModel = ""

RewriteQuery param.Field[bool]Optional

Body param

ScoreThreshold param.Field[float64]Optional

Body param

maximum1

minimum0

Source param.Field[string]Optional

Body param

SourceParams param.Field[NamespaceInstanceUpdateParamsSourceParams]Optional

Body param

ExcludeItems []stringOptional

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)

IncludeItems []stringOptional

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 stringOptional

R2Jurisdiction stringOptional

WebCrawler NamespaceInstanceUpdateParamsSourceParamsWebCrawlerOptional

ParseOptions NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptionsOptional

ContentSelector []NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelectorOptional

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. Omit the field to disable content selection — empty arrays are rejected.

Path string

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

maxLength200

minLength1

Selector string

CSS selector to extract content from pages matching the path pattern. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.

maxLength200

minLength1

IncludeHeaders map[string, string]Optional

Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).

IncludeImages boolOptional

SpecificSitemaps []stringOptional

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

UseBrowserRendering boolOptional

ParseType NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseTypeOptional

One of the following:

const NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType = "sitemap"

const NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseTypeCrawl NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType = "crawl"

Summarization param.Field[bool]Optional

Body param

SummarizationModel param.Field[NamespaceInstanceUpdateParamsSummarizationModel]Optional

Body param

const NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceUpdateParamsSummarizationModelCfZaiOrgGlm4_7Flash NamespaceInstanceUpdateParamsSummarizationModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateParamsSummarizationModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceUpdateParamsSummarizationModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceUpdateParamsSummarizationModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceUpdateParamsSummarizationModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceUpdateParamsSummarizationModelCfMoonshotaiKimiK2Instruct NamespaceInstanceUpdateParamsSummarizationModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceUpdateParamsSummarizationModelCfGoogleGemma3_12bIt NamespaceInstanceUpdateParamsSummarizationModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceUpdateParamsSummarizationModelCfGoogleGemma4_26bA4bIt NamespaceInstanceUpdateParamsSummarizationModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceUpdateParamsSummarizationModelCfMoonshotaiKimiK2_5 NamespaceInstanceUpdateParamsSummarizationModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaude3_7Sonnet NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaudeSonnet4 NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaudeOpus4 NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-opus-4"

const NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaude3_5Haiku NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceUpdateParamsSummarizationModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceUpdateParamsSummarizationModelCerebrasQwen3_235bA22bThinking NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceUpdateParamsSummarizationModelCerebrasLlama3_3_70b NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceUpdateParamsSummarizationModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceUpdateParamsSummarizationModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateParamsSummarizationModelCerebrasGptOSs120b NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceUpdateParamsSummarizationModelGoogleAIStudioGemini2_5Flash NamespaceInstanceUpdateParamsSummarizationModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceUpdateParamsSummarizationModelGoogleAIStudioGemini2_5Pro NamespaceInstanceUpdateParamsSummarizationModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceUpdateParamsSummarizationModelGrokGrok4 NamespaceInstanceUpdateParamsSummarizationModel = "grok/grok-4"

const NamespaceInstanceUpdateParamsSummarizationModelGroqLlama3_3_70bVersatile NamespaceInstanceUpdateParamsSummarizationModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceUpdateParamsSummarizationModelGroqLlama3_1_8bInstant NamespaceInstanceUpdateParamsSummarizationModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceUpdateParamsSummarizationModelOpenAIGpt5 NamespaceInstanceUpdateParamsSummarizationModel = "openai/gpt-5"

const NamespaceInstanceUpdateParamsSummarizationModelOpenAIGpt5Mini NamespaceInstanceUpdateParamsSummarizationModel = "openai/gpt-5-mini"

const NamespaceInstanceUpdateParamsSummarizationModelOpenAIGpt5Nano NamespaceInstanceUpdateParamsSummarizationModel = "openai/gpt-5-nano"

const NamespaceInstanceUpdateParamsSummarizationModelEmpty NamespaceInstanceUpdateParamsSummarizationModel = ""

SyncInterval param.Field[NamespaceInstanceUpdateParamsSyncInterval]Optional

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

const NamespaceInstanceUpdateParamsSyncInterval900 NamespaceInstanceUpdateParamsSyncInterval = 900

const NamespaceInstanceUpdateParamsSyncInterval1800 NamespaceInstanceUpdateParamsSyncInterval = 1800

const NamespaceInstanceUpdateParamsSyncInterval3600 NamespaceInstanceUpdateParamsSyncInterval = 3600

const NamespaceInstanceUpdateParamsSyncInterval7200 NamespaceInstanceUpdateParamsSyncInterval = 7200

const NamespaceInstanceUpdateParamsSyncInterval14400 NamespaceInstanceUpdateParamsSyncInterval = 14400

const NamespaceInstanceUpdateParamsSyncInterval21600 NamespaceInstanceUpdateParamsSyncInterval = 21600

const NamespaceInstanceUpdateParamsSyncInterval43200 NamespaceInstanceUpdateParamsSyncInterval = 43200

const NamespaceInstanceUpdateParamsSyncInterval86400 NamespaceInstanceUpdateParamsSyncInterval = 86400

SystemPromptAISearch param.Field[string]Optional

Body param

SystemPromptIndexSummarization param.Field[string]Optional

Body param

SystemPromptRewriteQuery param.Field[string]Optional

Body param

TokenID param.Field[string]Optional

Body param

formatuuid

ReturnsExpand Collapse

type NamespaceInstanceUpdateResponse struct{…}

ID string

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

maxLength64

minLength1

CreatedAt Time

formatdate-time

ModifiedAt Time

formatdate-time

AIGatewayID stringOptional

AISearchModel NamespaceInstanceUpdateResponseAISearchModelOptional

One of the following:

const NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceUpdateResponseAISearchModelCfZaiOrgGlm4_7Flash NamespaceInstanceUpdateResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateResponseAISearchModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceUpdateResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceUpdateResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceUpdateResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceUpdateResponseAISearchModelCfMoonshotaiKimiK2Instruct NamespaceInstanceUpdateResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceUpdateResponseAISearchModelCfGoogleGemma3_12bIt NamespaceInstanceUpdateResponseAISearchModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceUpdateResponseAISearchModelCfGoogleGemma4_26bA4bIt NamespaceInstanceUpdateResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceUpdateResponseAISearchModelCfMoonshotaiKimiK2_5 NamespaceInstanceUpdateResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceUpdateResponseAISearchModelAnthropicClaude3_7Sonnet NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceUpdateResponseAISearchModelAnthropicClaudeSonnet4 NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceUpdateResponseAISearchModelAnthropicClaudeOpus4 NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-opus-4"

const NamespaceInstanceUpdateResponseAISearchModelAnthropicClaude3_5Haiku NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceUpdateResponseAISearchModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceUpdateResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceUpdateResponseAISearchModelCerebrasQwen3_235bA22bThinking NamespaceInstanceUpdateResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceUpdateResponseAISearchModelCerebrasLlama3_3_70b NamespaceInstanceUpdateResponseAISearchModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceUpdateResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceUpdateResponseAISearchModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceUpdateResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateResponseAISearchModelCerebrasGptOSs120b NamespaceInstanceUpdateResponseAISearchModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceUpdateResponseAISearchModelGoogleAIStudioGemini2_5Flash NamespaceInstanceUpdateResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceUpdateResponseAISearchModelGoogleAIStudioGemini2_5Pro NamespaceInstanceUpdateResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceUpdateResponseAISearchModelGrokGrok4 NamespaceInstanceUpdateResponseAISearchModel = "grok/grok-4"

const NamespaceInstanceUpdateResponseAISearchModelGroqLlama3_3_70bVersatile NamespaceInstanceUpdateResponseAISearchModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceUpdateResponseAISearchModelGroqLlama3_1_8bInstant NamespaceInstanceUpdateResponseAISearchModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceUpdateResponseAISearchModelOpenAIGpt5 NamespaceInstanceUpdateResponseAISearchModel = "openai/gpt-5"

const NamespaceInstanceUpdateResponseAISearchModelOpenAIGpt5Mini NamespaceInstanceUpdateResponseAISearchModel = "openai/gpt-5-mini"

const NamespaceInstanceUpdateResponseAISearchModelOpenAIGpt5Nano NamespaceInstanceUpdateResponseAISearchModel = "openai/gpt-5-nano"

const NamespaceInstanceUpdateResponseAISearchModelEmpty NamespaceInstanceUpdateResponseAISearchModel = ""

Cache boolOptional

CacheThreshold NamespaceInstanceUpdateResponseCacheThresholdOptional

One of the following:

const NamespaceInstanceUpdateResponseCacheThresholdSuperStrictMatch NamespaceInstanceUpdateResponseCacheThreshold = "super_strict_match"

const NamespaceInstanceUpdateResponseCacheThresholdCloseEnough NamespaceInstanceUpdateResponseCacheThreshold = "close_enough"

const NamespaceInstanceUpdateResponseCacheThresholdFlexibleFriend NamespaceInstanceUpdateResponseCacheThreshold = "flexible_friend"

const NamespaceInstanceUpdateResponseCacheThresholdAnythingGoes NamespaceInstanceUpdateResponseCacheThreshold = "anything_goes"

CacheTTL NamespaceInstanceUpdateResponseCacheTTLOptional

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

One of the following:

const NamespaceInstanceUpdateResponseCacheTTL600 NamespaceInstanceUpdateResponseCacheTTL = 600

const NamespaceInstanceUpdateResponseCacheTTL1800 NamespaceInstanceUpdateResponseCacheTTL = 1800

const NamespaceInstanceUpdateResponseCacheTTL3600 NamespaceInstanceUpdateResponseCacheTTL = 3600

const NamespaceInstanceUpdateResponseCacheTTL7200 NamespaceInstanceUpdateResponseCacheTTL = 7200

const NamespaceInstanceUpdateResponseCacheTTL21600 NamespaceInstanceUpdateResponseCacheTTL = 21600

const NamespaceInstanceUpdateResponseCacheTTL43200 NamespaceInstanceUpdateResponseCacheTTL = 43200

const NamespaceInstanceUpdateResponseCacheTTL86400 NamespaceInstanceUpdateResponseCacheTTL = 86400

const NamespaceInstanceUpdateResponseCacheTTL172800 NamespaceInstanceUpdateResponseCacheTTL = 172800

const NamespaceInstanceUpdateResponseCacheTTL259200 NamespaceInstanceUpdateResponseCacheTTL = 259200

const NamespaceInstanceUpdateResponseCacheTTL518400 NamespaceInstanceUpdateResponseCacheTTL = 518400

ChunkOverlap int64Optional

maximum30

minimum0

ChunkSize int64Optional

minimum64

CreatedBy stringOptional

CustomMetadata []NamespaceInstanceUpdateResponseCustomMetadataOptional

DataType NamespaceInstanceUpdateResponseCustomMetadataDataType

One of the following:

const NamespaceInstanceUpdateResponseCustomMetadataDataTypeText NamespaceInstanceUpdateResponseCustomMetadataDataType = "text"

const NamespaceInstanceUpdateResponseCustomMetadataDataTypeNumber NamespaceInstanceUpdateResponseCustomMetadataDataType = "number"

const NamespaceInstanceUpdateResponseCustomMetadataDataTypeBoolean NamespaceInstanceUpdateResponseCustomMetadataDataType = "boolean"

const NamespaceInstanceUpdateResponseCustomMetadataDataTypeDatetime NamespaceInstanceUpdateResponseCustomMetadataDataType = "datetime"

FieldName string

maxLength64

minLength1

EmbeddingModel NamespaceInstanceUpdateResponseEmbeddingModelOptional

One of the following:

const NamespaceInstanceUpdateResponseEmbeddingModelCfQwenQwen3Embedding0_6b NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"

const NamespaceInstanceUpdateResponseEmbeddingModelCfQwenQwen3VlEmbedding2b NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/qwen/qwen3-vl-embedding-2b"

const NamespaceInstanceUpdateResponseEmbeddingModelCfBaaiBgeM3 NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/baai/bge-m3"

const NamespaceInstanceUpdateResponseEmbeddingModelCfBaaiBgeLargeEnV1_5 NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"

const NamespaceInstanceUpdateResponseEmbeddingModelCfGoogleEmbeddinggemma300m NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"

const NamespaceInstanceUpdateResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001 NamespaceInstanceUpdateResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"

const NamespaceInstanceUpdateResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceUpdateResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"

const NamespaceInstanceUpdateResponseEmbeddingModelOpenAITextEmbedding3Small NamespaceInstanceUpdateResponseEmbeddingModel = "openai/text-embedding-3-small"

const NamespaceInstanceUpdateResponseEmbeddingModelOpenAITextEmbedding3Large NamespaceInstanceUpdateResponseEmbeddingModel = "openai/text-embedding-3-large"

const NamespaceInstanceUpdateResponseEmbeddingModelEmpty NamespaceInstanceUpdateResponseEmbeddingModel = ""

Enable boolOptional

EngineVersion float64Optional

FusionMethod NamespaceInstanceUpdateResponseFusionMethodOptional

One of the following:

const NamespaceInstanceUpdateResponseFusionMethodMax NamespaceInstanceUpdateResponseFusionMethod = "max"

const NamespaceInstanceUpdateResponseFusionMethodRrf NamespaceInstanceUpdateResponseFusionMethod = "rrf"

DeprecatedHybridSearchEnabled boolOptional

Deprecated — use index_method instead.

IndexMethod NamespaceInstanceUpdateResponseIndexMethodOptional

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

Keyword bool

Enable keyword (BM25) storage backend.

Vector bool

Enable vector (embedding) storage backend.

IndexingOptions NamespaceInstanceUpdateResponseIndexingOptionsOptional

KeywordTokenizer NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizerOptional

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.

One of the following:

const NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizerPorter NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer = "porter"

const NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer = "trigram"

LastActivity TimeOptional

formatdate-time

MaxNumResults int64Optional

maximum50

minimum1

Metadata NamespaceInstanceUpdateResponseMetadataOptional

CreatedFromAISearchWizard boolOptional

WorkerDomain stringOptional

ModifiedBy stringOptional

Namespace stringOptional

Paused boolOptional

PublicEndpointID stringOptional

PublicEndpointParams NamespaceInstanceUpdateResponsePublicEndpointParamsOptional

AuthorizedHosts []stringOptional

ChatCompletionsEndpoint NamespaceInstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpointOptional

Disabled boolOptional

Disable chat completions endpoint for this public endpoint

Enabled boolOptional

Mcp NamespaceInstanceUpdateResponsePublicEndpointParamsMcpOptional

Description stringOptional

Disabled boolOptional

Disable MCP endpoint for this public endpoint

RateLimit NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitOptional

PeriodMs int64Optional

maximum3600000

minimum60000

Requests int64Optional

minimum1

Technique NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueOptional

One of the following:

const NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueFixed NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "fixed"

const NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "sliding"

SearchEndpoint NamespaceInstanceUpdateResponsePublicEndpointParamsSearchEndpointOptional

Disabled boolOptional

Disable search endpoint for this public endpoint

Reranking boolOptional

RerankingModel NamespaceInstanceUpdateResponseRerankingModelOptional

One of the following:

const NamespaceInstanceUpdateResponseRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceUpdateResponseRerankingModel = "@cf/baai/bge-reranker-base"

const NamespaceInstanceUpdateResponseRerankingModelEmpty NamespaceInstanceUpdateResponseRerankingModel = ""

RetrievalOptions NamespaceInstanceUpdateResponseRetrievalOptionsOptional

BoostBy []NamespaceInstanceUpdateResponseRetrievalOptionsBoostByOptional

Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to ‘asc’ for numeric/datetime 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 all four directions (asc, desc, exists, not_exists); text/boolean fields only support exists/not_exists.

maxLength64

minLength1

Direction NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionOptional

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.

One of the following:

const NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionAsc NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "asc"

const NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionDesc NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "desc"

const NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionExists NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "exists"

const NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "not_exists"

KeywordMatchMode NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchModeOptional

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

One of the following:

const NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "and"

const NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchModeOr NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "or"

RewriteModel NamespaceInstanceUpdateResponseRewriteModelOptional

One of the following:

const NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceUpdateResponseRewriteModelCfZaiOrgGlm4_7Flash NamespaceInstanceUpdateResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateResponseRewriteModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceUpdateResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceUpdateResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceUpdateResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceUpdateResponseRewriteModelCfMoonshotaiKimiK2Instruct NamespaceInstanceUpdateResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceUpdateResponseRewriteModelCfGoogleGemma3_12bIt NamespaceInstanceUpdateResponseRewriteModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceUpdateResponseRewriteModelCfGoogleGemma4_26bA4bIt NamespaceInstanceUpdateResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceUpdateResponseRewriteModelCfMoonshotaiKimiK2_5 NamespaceInstanceUpdateResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceUpdateResponseRewriteModelAnthropicClaude3_7Sonnet NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceUpdateResponseRewriteModelAnthropicClaudeSonnet4 NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceUpdateResponseRewriteModelAnthropicClaudeOpus4 NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-opus-4"

const NamespaceInstanceUpdateResponseRewriteModelAnthropicClaude3_5Haiku NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceUpdateResponseRewriteModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceUpdateResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceUpdateResponseRewriteModelCerebrasQwen3_235bA22bThinking NamespaceInstanceUpdateResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceUpdateResponseRewriteModelCerebrasLlama3_3_70b NamespaceInstanceUpdateResponseRewriteModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceUpdateResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceUpdateResponseRewriteModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceUpdateResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceUpdateResponseRewriteModelCerebrasGptOSs120b NamespaceInstanceUpdateResponseRewriteModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceUpdateResponseRewriteModelGoogleAIStudioGemini2_5Flash NamespaceInstanceUpdateResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceUpdateResponseRewriteModelGoogleAIStudioGemini2_5Pro NamespaceInstanceUpdateResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceUpdateResponseRewriteModelGrokGrok4 NamespaceInstanceUpdateResponseRewriteModel = "grok/grok-4"

const NamespaceInstanceUpdateResponseRewriteModelGroqLlama3_3_70bVersatile NamespaceInstanceUpdateResponseRewriteModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceUpdateResponseRewriteModelGroqLlama3_1_8bInstant NamespaceInstanceUpdateResponseRewriteModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceUpdateResponseRewriteModelOpenAIGpt5 NamespaceInstanceUpdateResponseRewriteModel = "openai/gpt-5"

const NamespaceInstanceUpdateResponseRewriteModelOpenAIGpt5Mini NamespaceInstanceUpdateResponseRewriteModel = "openai/gpt-5-mini"

const NamespaceInstanceUpdateResponseRewriteModelOpenAIGpt5Nano NamespaceInstanceUpdateResponseRewriteModel = "openai/gpt-5-nano"

const NamespaceInstanceUpdateResponseRewriteModelEmpty NamespaceInstanceUpdateResponseRewriteModel = ""

RewriteQuery boolOptional

ScoreThreshold float64Optional

maximum1

minimum0

Source stringOptional

SourceParams NamespaceInstanceUpdateResponseSourceParamsOptional

ExcludeItems []stringOptional

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)

IncludeItems []stringOptional

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 stringOptional

R2Jurisdiction stringOptional

WebCrawler NamespaceInstanceUpdateResponseSourceParamsWebCrawlerOptional

ParseOptions NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsOptional

ContentSelector []NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelectorOptional

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. Omit the field to disable content selection — empty arrays are rejected.

Path string

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

maxLength200

minLength1

Selector string

CSS selector to extract content from pages matching the path pattern. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.

maxLength200

minLength1

IncludeHeaders map[string, string]Optional

Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).

IncludeImages boolOptional

SpecificSitemaps []stringOptional

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

UseBrowserRendering boolOptional

ParseType NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseTypeOptional

One of the following:

const NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType = "sitemap"

const NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseTypeCrawl NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType = "crawl"

Status stringOptional

SyncInterval NamespaceInstanceUpdateResponseSyncIntervalOptional

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

One of the following:

const NamespaceInstanceUpdateResponseSyncInterval900 NamespaceInstanceUpdateResponseSyncInterval = 900

const NamespaceInstanceUpdateResponseSyncInterval1800 NamespaceInstanceUpdateResponseSyncInterval = 1800

const NamespaceInstanceUpdateResponseSyncInterval3600 NamespaceInstanceUpdateResponseSyncInterval = 3600

const NamespaceInstanceUpdateResponseSyncInterval7200 NamespaceInstanceUpdateResponseSyncInterval = 7200

const NamespaceInstanceUpdateResponseSyncInterval14400 NamespaceInstanceUpdateResponseSyncInterval = 14400

const NamespaceInstanceUpdateResponseSyncInterval21600 NamespaceInstanceUpdateResponseSyncInterval = 21600

const NamespaceInstanceUpdateResponseSyncInterval43200 NamespaceInstanceUpdateResponseSyncInterval = 43200

const NamespaceInstanceUpdateResponseSyncInterval86400 NamespaceInstanceUpdateResponseSyncInterval = 86400

TokenID stringOptional

formatuuid

Type NamespaceInstanceUpdateResponseTypeOptional

One of the following:

const NamespaceInstanceUpdateResponseTypeR2 NamespaceInstanceUpdateResponseType = "r2"

const NamespaceInstanceUpdateResponseTypeWebCrawler NamespaceInstanceUpdateResponseType = "web-crawler"

Update instance.

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/ai_search"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  instance, err := client.AISearch.Namespaces.Instances.Update(
    context.TODO(),
    "my-namespace",
    "my-ai-search",
    ai_search.NamespaceInstanceUpdateParams{
      AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", instance.ID)
}

200 example

{
  "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",
    "cache_ttl": 600,
    "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,
      "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": {
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article div.post-body"
            },
            {
              "path": "**/docs/**",
              "selector": "main"
            }
          ],
          "include_headers": {
            "cache-control": "no-cache, no-store"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap"
      }
    },
    "status": "status",
    "sync_interval": 900,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}

Returns Examples

200 example

{
  "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",
    "cache_ttl": 600,
    "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,
      "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": {
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article div.post-body"
            },
            {
              "path": "**/docs/**",
              "selector": "main"
            }
          ],
          "include_headers": {
            "cache-control": "no-cache, no-store"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap"
      }
    },
    "status": "status",
    "sync_interval": 900,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}