--- title: Update an AI Search instance (Search for Agents metadata requires the default namespace). --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [AI Search](https://developers.cloudflare.com/api/go/resources/ai_search) [Instances](https://developers.cloudflare.com/api/go/resources/ai_search/subresources/instances) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update an AI Search instance (Search for Agents metadata requires the default namespace). Deprecated client.AISearch.Instances.Update(ctx, id, params) (\*[InstanceUpdateResponse](), error) PUT/accounts/{account\_id}/ai-search/instances/{id} Update an AI Search instance. Submitting Search for Agents metadata requires the default namespace; omitting or removing it is allowed elsewhere. Submit Search for Agents metadata and restrictive or unknown public endpoint changes or custom domains in separate PUT requests, even when resubmitting unchanged metadata. Deprecated: use /accounts/{account\_id}/ai-search/namespaces/{name}/instances (and descendant paths) instead. ##### 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 id string [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>)
params InstanceUpdateParams AccountID param.Field\[string] Path param Link to this property AIGatewayID param.Field\[string]Optional Body param Link to this property AISearchModel param.Field\[string]Optional Body param: A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model. Link to this property Cache param.Field\[bool]Optional Body param Link to this property
CacheThreshold param.Field\[InstanceUpdateParamsCacheThreshold]Optional Body param const InstanceUpdateParamsCacheThresholdSuperStrictMatch InstanceUpdateParamsCacheThreshold = "super\_strict\_match" Link to this property const InstanceUpdateParamsCacheThresholdCloseEnough InstanceUpdateParamsCacheThreshold = "close\_enough" Link to this property const InstanceUpdateParamsCacheThresholdFlexibleFriend InstanceUpdateParamsCacheThreshold = "flexible\_friend" Link to this property const InstanceUpdateParamsCacheThresholdAnythingGoes InstanceUpdateParamsCacheThreshold = "anything\_goes" Link to this property
Link to this property
CacheTTL param.Field\[InstanceUpdateParamsCacheTTL]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 InstanceUpdateParamsCacheTTL600 InstanceUpdateParamsCacheTTL = 600 Link to this property const InstanceUpdateParamsCacheTTL1800 InstanceUpdateParamsCacheTTL = 1800 Link to this property const InstanceUpdateParamsCacheTTL3600 InstanceUpdateParamsCacheTTL = 3600 Link to this property const InstanceUpdateParamsCacheTTL7200 InstanceUpdateParamsCacheTTL = 7200 Link to this property const InstanceUpdateParamsCacheTTL21600 InstanceUpdateParamsCacheTTL = 21600 Link to this property const InstanceUpdateParamsCacheTTL43200 InstanceUpdateParamsCacheTTL = 43200 Link to this property const InstanceUpdateParamsCacheTTL86400 InstanceUpdateParamsCacheTTL = 86400 Link to this property const InstanceUpdateParamsCacheTTL172800 InstanceUpdateParamsCacheTTL = 172800 Link to this property const InstanceUpdateParamsCacheTTL259200 InstanceUpdateParamsCacheTTL = 259200 Link to this property const InstanceUpdateParamsCacheTTL518400 InstanceUpdateParamsCacheTTL = 518400 Link to this property
Link to this property Chunk param.Field\[bool]Optional Body param Link to this property ChunkOverlap param.Field\[int64]Optional Body param maximum30 minimum0 Link to this property ChunkSize param.Field\[int64]Optional Body param minimum64 Link to this property
CustomMetadata param.Field\[\[]InstanceUpdateParamsCustomMetadata]Optional Body param
DataType InstanceUpdateParamsCustomMetadataDataType One of the following: const InstanceUpdateParamsCustomMetadataDataTypeText InstanceUpdateParamsCustomMetadataDataType = "text" Link to this property const InstanceUpdateParamsCustomMetadataDataTypeNumber InstanceUpdateParamsCustomMetadataDataType = "number" Link to this property const InstanceUpdateParamsCustomMetadataDataTypeBoolean InstanceUpdateParamsCustomMetadataDataType = "boolean" Link to this property const InstanceUpdateParamsCustomMetadataDataTypeDatetime InstanceUpdateParamsCustomMetadataDataType = "datetime" Link to this property
Link to this property FieldName string maxLength64 minLength1 Link to this property
Link to this property EmbeddingModel param.Field\[string]Optional Body param Link to this property
FusionMethod param.Field\[InstanceUpdateParamsFusionMethod]Optional Body param const InstanceUpdateParamsFusionMethodMax InstanceUpdateParamsFusionMethod = "max" Link to this property const InstanceUpdateParamsFusionMethodRrf InstanceUpdateParamsFusionMethod = "rrf" Link to this property
Link to this property
IndexMethod param.Field\[InstanceUpdateParamsIndexMethod]Optional Body param: Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances. Keyword bool Enable keyword (BM25) storage backend. Link to this property Vector bool Enable vector (embedding) storage backend. Link to this property
Link to this property
IndexingOptions param.Field\[InstanceUpdateParamsIndexingOptions]Optional Body param
KeywordTokenizer InstanceUpdateParamsIndexingOptionsKeywordTokenizerOptional 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 InstanceUpdateParamsIndexingOptionsKeywordTokenizerPorter InstanceUpdateParamsIndexingOptionsKeywordTokenizer = "porter" Link to this property const InstanceUpdateParamsIndexingOptionsKeywordTokenizerTrigram InstanceUpdateParamsIndexingOptionsKeywordTokenizer = "trigram" Link to this property
Link to this property UseOCR boolOptional Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. Link to this property
Link to this property MaxNumResults param.Field\[int64]Optional Body param maximum50 minimum1 Link to this property
Metadata param.Field\[InstanceUpdateParamsMetadata]Optional Body param CreatedFromAISearchWizard boolOptional Link to this property WorkerDomain stringOptional Link to this property
Link to this property Paused param.Field\[bool]Optional Body param Link to this property
PublicEndpointParams param.Field\[InstanceUpdateParamsPublicEndpointParams]Optional Body param AuthorizedHosts \[]stringOptional Link to this property
ChatCompletionsEndpoint InstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpointOptional Disabled boolOptional Disable chat completions endpoint for this public endpoint Link to this property
Link to this property CustomDomains \[]stringOptional 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). Link to this property DefaultDomainEnabled boolOptional 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. Link to this property Enabled boolOptional Link to this property
Mcp InstanceUpdateParamsPublicEndpointParamsMcpOptional Description stringOptional Link to this property Disabled boolOptional Disable MCP endpoint for this public endpoint Link to this property
Link to this property
RateLimit InstanceUpdateParamsPublicEndpointParamsRateLimitOptional PeriodMs int64Optional maximum3600000 minimum60000 Link to this property Requests int64Optional minimum1 Link to this property
Technique InstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueOptional One of the following: const InstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueFixed InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "fixed" Link to this property const InstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueSliding InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "sliding" Link to this property
Link to this property
Link to this property
SearchEndpoint InstanceUpdateParamsPublicEndpointParamsSearchEndpointOptional Disabled boolOptional Disable search endpoint for this public endpoint Link to this property
Link to this property
Link to this property Reranking param.Field\[bool]Optional Body param Link to this property RerankingModel param.Field\[string]Optional Body param Link to this property
RetrievalOptions param.Field\[InstanceUpdateParamsRetrievalOptions]Optional Body param
BoostBy \[]InstanceUpdateParamsRetrievalOptionsBoostByOptional 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 Link to this property
Direction InstanceUpdateParamsRetrievalOptionsBoostByDirectionOptional 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 InstanceUpdateParamsRetrievalOptionsBoostByDirectionAsc InstanceUpdateParamsRetrievalOptionsBoostByDirection = "asc" Link to this property const InstanceUpdateParamsRetrievalOptionsBoostByDirectionDesc InstanceUpdateParamsRetrievalOptionsBoostByDirection = "desc" Link to this property const InstanceUpdateParamsRetrievalOptionsBoostByDirectionExists InstanceUpdateParamsRetrievalOptionsBoostByDirection = "exists" Link to this property const InstanceUpdateParamsRetrievalOptionsBoostByDirectionNotExists InstanceUpdateParamsRetrievalOptionsBoostByDirection = "not\_exists" Link to this property
Link to this property
Link to this property
KeywordMatchMode InstanceUpdateParamsRetrievalOptionsKeywordMatchModeOptional 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back to ‘and’. One of the following: const InstanceUpdateParamsRetrievalOptionsKeywordMatchModeAnd InstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "and" Link to this property const InstanceUpdateParamsRetrievalOptionsKeywordMatchModeOr InstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "or" Link to this property
Link to this property
Link to this property RewriteModel param.Field\[string]Optional Body param: A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model. Link to this property RewriteQuery param.Field\[bool]Optional Body param Link to this property ScoreThreshold param.Field\[float64]Optional Body param maximum1 minimum0 Link to this property Source param.Field\[string]Optional Body param Link to this property
SourceParams param.Field\[InstanceUpdateParamsSourceParams]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). Most accounts are limited to 10 rules; contact support to raise it. Link to this property 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). Most accounts are limited to 10 rules; contact support to raise it. Link to this property Prefix stringOptional Link to this property R2Jurisdiction stringOptional Link to this property
WebCrawler InstanceUpdateParamsSourceParamsWebCrawlerOptional
DiscoverOptions InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsOptional Options for parse\_type ‘discover’, where Browser Run discovers URLs by link following and sitemaps. Ignored for ‘sitemap’. Depth float64Optional Maximum link-follow depth from the seed URL. maximum100000 minimum1 Link to this property IncludeExternalLinks boolOptional Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own. Link to this property IncludeSubdomains boolOptional Follow links to subdomains of the source host. Link to this property Limit float64Optional Maximum number of pages to crawl (1-100000). maximum100000 minimum1 Link to this property MaxAge float64Optional Maximum content age in seconds to accept (0–604800). maximum604800 minimum0 Link to this property
Source InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsSourceOptional Where the crawler looks for URLs: ‘sitemaps’ reads sitemap XML only, ‘links’ follows page links only, ‘all’ does both. One of the following: const InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsSourceAll InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsSource = "all" Link to this property const InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsSourceSitemaps InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsSource = "sitemaps" Link to this property const InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsSourceLinks InstanceUpdateParamsSourceParamsWebCrawlerDiscoverOptionsSource = "links" Link to this property
Link to this property
Link to this property
ParseOptions InstanceUpdateParamsSourceParamsWebCrawlerParseOptionsOptional
ContentSelector \[]InstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelectorOptional 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 Link to this property 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 Link to this property
Link to this property 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). Link to this property IncludeImages boolOptional Link to this property SpecificSitemaps \[]stringOptional List of specific sitemap URLs to use for crawling. Only valid when parse\_type is ‘sitemap’. Link to this property UseBrowserRendering boolOptional Link to this property
Link to this property
ParseType InstanceUpdateParamsSourceParamsWebCrawlerParseTypeOptional How URLs are discovered. ‘sitemap’ reads XML sitemaps; ‘discover’ follows links recursively and requires the source to be a Verified zone on this account. One of the following: const InstanceUpdateParamsSourceParamsWebCrawlerParseTypeSitemap InstanceUpdateParamsSourceParamsWebCrawlerParseType = "sitemap" Link to this property const InstanceUpdateParamsSourceParamsWebCrawlerParseTypeDiscover InstanceUpdateParamsSourceParamsWebCrawlerParseType = "discover" Link to this property
Link to this property
Link to this property
Link to this property Summarization param.Field\[bool]Optional Body param Link to this property SummarizationModel param.Field\[string]Optional Body param Link to this property
SyncInterval param.Field\[InstanceUpdateParamsSyncInterval]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 InstanceUpdateParamsSyncInterval900 InstanceUpdateParamsSyncInterval = 900 Link to this property const InstanceUpdateParamsSyncInterval1800 InstanceUpdateParamsSyncInterval = 1800 Link to this property const InstanceUpdateParamsSyncInterval3600 InstanceUpdateParamsSyncInterval = 3600 Link to this property const InstanceUpdateParamsSyncInterval7200 InstanceUpdateParamsSyncInterval = 7200 Link to this property const InstanceUpdateParamsSyncInterval14400 InstanceUpdateParamsSyncInterval = 14400 Link to this property const InstanceUpdateParamsSyncInterval21600 InstanceUpdateParamsSyncInterval = 21600 Link to this property const InstanceUpdateParamsSyncInterval43200 InstanceUpdateParamsSyncInterval = 43200 Link to this property const InstanceUpdateParamsSyncInterval86400 InstanceUpdateParamsSyncInterval = 86400 Link to this property
Link to this property SystemPromptAISearch param.Field\[string]Optional Body param Link to this property SystemPromptIndexSummarization param.Field\[string]Optional Body param Link to this property SystemPromptRewriteQuery param.Field\[string]Optional Body param Link to this property TokenID param.Field\[string]Optional Body param formatuuid Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type InstanceUpdateResponse struct{…} ID string AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. maxLength64 minLength1 Link to this property CreatedAt Time formatdate-time Link to this property ModifiedAt Time formatdate-time Link to this property AIGatewayID stringOptional Link to this property AISearchModel stringOptional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model. Link to this property Cache boolOptional Link to this property
CacheThreshold InstanceUpdateResponseCacheThresholdOptional One of the following: const InstanceUpdateResponseCacheThresholdSuperStrictMatch InstanceUpdateResponseCacheThreshold = "super\_strict\_match" Link to this property const InstanceUpdateResponseCacheThresholdCloseEnough InstanceUpdateResponseCacheThreshold = "close\_enough" Link to this property const InstanceUpdateResponseCacheThresholdFlexibleFriend InstanceUpdateResponseCacheThreshold = "flexible\_friend" Link to this property const InstanceUpdateResponseCacheThresholdAnythingGoes InstanceUpdateResponseCacheThreshold = "anything\_goes" Link to this property
Link to this property
CacheTTL InstanceUpdateResponseCacheTTLOptional 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 InstanceUpdateResponseCacheTTL600 InstanceUpdateResponseCacheTTL = 600 Link to this property const InstanceUpdateResponseCacheTTL1800 InstanceUpdateResponseCacheTTL = 1800 Link to this property const InstanceUpdateResponseCacheTTL3600 InstanceUpdateResponseCacheTTL = 3600 Link to this property const InstanceUpdateResponseCacheTTL7200 InstanceUpdateResponseCacheTTL = 7200 Link to this property const InstanceUpdateResponseCacheTTL21600 InstanceUpdateResponseCacheTTL = 21600 Link to this property const InstanceUpdateResponseCacheTTL43200 InstanceUpdateResponseCacheTTL = 43200 Link to this property const InstanceUpdateResponseCacheTTL86400 InstanceUpdateResponseCacheTTL = 86400 Link to this property const InstanceUpdateResponseCacheTTL172800 InstanceUpdateResponseCacheTTL = 172800 Link to this property const InstanceUpdateResponseCacheTTL259200 InstanceUpdateResponseCacheTTL = 259200 Link to this property const InstanceUpdateResponseCacheTTL518400 InstanceUpdateResponseCacheTTL = 518400 Link to this property
Link to this property ChunkOverlap int64Optional maximum30 minimum0 Link to this property ChunkSize int64Optional minimum64 Link to this property CreatedBy stringOptional Link to this property
CustomMetadata \[]InstanceUpdateResponseCustomMetadataOptional
DataType InstanceUpdateResponseCustomMetadataDataType One of the following: const InstanceUpdateResponseCustomMetadataDataTypeText InstanceUpdateResponseCustomMetadataDataType = "text" Link to this property const InstanceUpdateResponseCustomMetadataDataTypeNumber InstanceUpdateResponseCustomMetadataDataType = "number" Link to this property const InstanceUpdateResponseCustomMetadataDataTypeBoolean InstanceUpdateResponseCustomMetadataDataType = "boolean" Link to this property const InstanceUpdateResponseCustomMetadataDataTypeDatetime InstanceUpdateResponseCustomMetadataDataType = "datetime" Link to this property
Link to this property FieldName string maxLength64 minLength1 Link to this property
Link to this property EmbeddingModel stringOptional Link to this property Enable boolOptional Link to this property EngineVersion float64Optional Link to this property
FusionMethod InstanceUpdateResponseFusionMethodOptional One of the following: const InstanceUpdateResponseFusionMethodMax InstanceUpdateResponseFusionMethod = "max" Link to this property const InstanceUpdateResponseFusionMethodRrf InstanceUpdateResponseFusionMethod = "rrf" Link to this property
Link to this property DeprecatedHybridSearchEnabled boolOptional Deprecated — use index\_method instead. Defaults to true for new instances; set false to create a vector-only instance. Link to this property
IndexMethod InstanceUpdateResponseIndexMethodOptional Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances. Keyword bool Enable keyword (BM25) storage backend. Link to this property Vector bool Enable vector (embedding) storage backend. Link to this property
Link to this property
IndexingOptions InstanceUpdateResponseIndexingOptionsOptional
KeywordTokenizer InstanceUpdateResponseIndexingOptionsKeywordTokenizerOptional 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 InstanceUpdateResponseIndexingOptionsKeywordTokenizerPorter InstanceUpdateResponseIndexingOptionsKeywordTokenizer = "porter" Link to this property const InstanceUpdateResponseIndexingOptionsKeywordTokenizerTrigram InstanceUpdateResponseIndexingOptionsKeywordTokenizer = "trigram" Link to this property
Link to this property UseOCR boolOptional Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. Link to this property
Link to this property LastActivity TimeOptional formatdate-time Link to this property MaxNumResults int64Optional maximum50 minimum1 Link to this property
Metadata InstanceUpdateResponseMetadataOptional CreatedFromAISearchWizard boolOptional Link to this property WorkerDomain stringOptional Link to this property
Link to this property ModifiedBy stringOptional Link to this property Namespace stringOptional Link to this property Paused boolOptional Link to this property PublicEndpointID stringOptional Link to this property
PublicEndpointParams InstanceUpdateResponsePublicEndpointParamsOptional AuthorizedHosts \[]stringOptional Link to this property
ChatCompletionsEndpoint InstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpointOptional Disabled boolOptional Disable chat completions endpoint for this public endpoint Link to this property
Link to this property CustomDomains \[]stringOptional 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). Link to this property DefaultDomainEnabled boolOptional 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. Link to this property Enabled boolOptional Link to this property
Mcp InstanceUpdateResponsePublicEndpointParamsMcpOptional Description stringOptional Link to this property Disabled boolOptional Disable MCP endpoint for this public endpoint Link to this property
Link to this property
RateLimit InstanceUpdateResponsePublicEndpointParamsRateLimitOptional PeriodMs int64Optional maximum3600000 minimum60000 Link to this property Requests int64Optional minimum1 Link to this property
Technique InstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueOptional One of the following: const InstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueFixed InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "fixed" Link to this property const InstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "sliding" Link to this property
Link to this property
Link to this property
SearchEndpoint InstanceUpdateResponsePublicEndpointParamsSearchEndpointOptional Disabled boolOptional Disable search endpoint for this public endpoint Link to this property
Link to this property
Link to this property Reranking boolOptional Link to this property RerankingModel stringOptional Link to this property
RetrievalOptions InstanceUpdateResponseRetrievalOptionsOptional
BoostBy \[]InstanceUpdateResponseRetrievalOptionsBoostByOptional 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 Link to this property
Direction InstanceUpdateResponseRetrievalOptionsBoostByDirectionOptional 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 InstanceUpdateResponseRetrievalOptionsBoostByDirectionAsc InstanceUpdateResponseRetrievalOptionsBoostByDirection = "asc" Link to this property const InstanceUpdateResponseRetrievalOptionsBoostByDirectionDesc InstanceUpdateResponseRetrievalOptionsBoostByDirection = "desc" Link to this property const InstanceUpdateResponseRetrievalOptionsBoostByDirectionExists InstanceUpdateResponseRetrievalOptionsBoostByDirection = "exists" Link to this property const InstanceUpdateResponseRetrievalOptionsBoostByDirectionNotExists InstanceUpdateResponseRetrievalOptionsBoostByDirection = "not\_exists" Link to this property
Link to this property
Link to this property
KeywordMatchMode InstanceUpdateResponseRetrievalOptionsKeywordMatchModeOptional 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back to ‘and’. One of the following: const InstanceUpdateResponseRetrievalOptionsKeywordMatchModeAnd InstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "and" Link to this property const InstanceUpdateResponseRetrievalOptionsKeywordMatchModeOr InstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "or" Link to this property
Link to this property
Link to this property RewriteModel stringOptional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model. Link to this property RewriteQuery boolOptional Link to this property ScoreThreshold float64Optional maximum1 minimum0 Link to this property Source stringOptional Link to this property
SourceParams InstanceUpdateResponseSourceParamsOptional 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). Most accounts are limited to 10 rules; contact support to raise it. Link to this property 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). Most accounts are limited to 10 rules; contact support to raise it. Link to this property Prefix stringOptional Link to this property R2Jurisdiction stringOptional Link to this property
WebCrawler InstanceUpdateResponseSourceParamsWebCrawlerOptional
DiscoverOptions InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsOptional Options for parse\_type ‘discover’, where Browser Run discovers URLs by link following and sitemaps. Ignored for ‘sitemap’. Depth float64Optional Maximum link-follow depth from the seed URL. maximum100000 minimum1 Link to this property IncludeExternalLinks boolOptional Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own. Link to this property IncludeSubdomains boolOptional Follow links to subdomains of the source host. Link to this property Limit float64Optional Maximum number of pages to crawl (1-100000). maximum100000 minimum1 Link to this property MaxAge float64Optional Maximum content age in seconds to accept (0–604800). maximum604800 minimum0 Link to this property
Source InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsSourceOptional Where the crawler looks for URLs: ‘sitemaps’ reads sitemap XML only, ‘links’ follows page links only, ‘all’ does both. One of the following: const InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsSourceAll InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsSource = "all" Link to this property const InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsSourceSitemaps InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsSource = "sitemaps" Link to this property const InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsSourceLinks InstanceUpdateResponseSourceParamsWebCrawlerDiscoverOptionsSource = "links" Link to this property
Link to this property
Link to this property
ParseOptions InstanceUpdateResponseSourceParamsWebCrawlerParseOptionsOptional
ContentSelector \[]InstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelectorOptional 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 Link to this property 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 Link to this property
Link to this property 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). Link to this property IncludeImages boolOptional Link to this property SpecificSitemaps \[]stringOptional List of specific sitemap URLs to use for crawling. Only valid when parse\_type is ‘sitemap’. Link to this property UseBrowserRendering boolOptional Link to this property
Link to this property
ParseType InstanceUpdateResponseSourceParamsWebCrawlerParseTypeOptional How URLs are discovered. ‘sitemap’ reads XML sitemaps; ‘discover’ follows links recursively and requires the source to be a Verified zone on this account. One of the following: const InstanceUpdateResponseSourceParamsWebCrawlerParseTypeSitemap InstanceUpdateResponseSourceParamsWebCrawlerParseType = "sitemap" Link to this property const InstanceUpdateResponseSourceParamsWebCrawlerParseTypeDiscover InstanceUpdateResponseSourceParamsWebCrawlerParseType = "discover" Link to this property
Link to this property
Link to this property
Link to this property Status stringOptional Link to this property
SyncInterval InstanceUpdateResponseSyncIntervalOptional 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 InstanceUpdateResponseSyncInterval900 InstanceUpdateResponseSyncInterval = 900 Link to this property const InstanceUpdateResponseSyncInterval1800 InstanceUpdateResponseSyncInterval = 1800 Link to this property const InstanceUpdateResponseSyncInterval3600 InstanceUpdateResponseSyncInterval = 3600 Link to this property const InstanceUpdateResponseSyncInterval7200 InstanceUpdateResponseSyncInterval = 7200 Link to this property const InstanceUpdateResponseSyncInterval14400 InstanceUpdateResponseSyncInterval = 14400 Link to this property const InstanceUpdateResponseSyncInterval21600 InstanceUpdateResponseSyncInterval = 21600 Link to this property const InstanceUpdateResponseSyncInterval43200 InstanceUpdateResponseSyncInterval = 43200 Link to this property const InstanceUpdateResponseSyncInterval86400 InstanceUpdateResponseSyncInterval = 86400 Link to this property
Link to this property TokenID stringOptional formatuuid Link to this property
Type InstanceUpdateResponseTypeOptional Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. One of the following: const InstanceUpdateResponseTypeR2 InstanceUpdateResponseType = "r2" Link to this property const InstanceUpdateResponseTypeWebCrawler InstanceUpdateResponseType = "web-crawler" Link to this property
Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20InstanceUpdateResponse%20%3E%20(schema)>) ### Update an AI Search instance (Search for Agents metadata requires the default namespace). Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/ai_search" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) instance, err := client.AISearch.Instances.Update( context.TODO(), "my-ai-search", ai_search.InstanceUpdateParams{ 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": "ai_search_model", "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": "embedding_model", "enable": true, "engine_version": 0, "fusion_method": "max", "hybrid_search_enabled": true, "index_method": { "keyword": true, "vector": true }, "indexing_options": { "keyword_tokenizer": "porter", "use_ocr": true }, "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 }, "custom_domains": [ "search.example.com" ], "default_domain_enabled": 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": "reranking_model", "retrieval_options": { "boost_by": [ { "field": "timestamp", "direction": "desc" } ], "keyword_match_mode": "and" }, "rewrite_model": "rewrite_model", "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": { "discover_options": { "depth": 5, "include_external_links": false, "include_subdomains": false, "limit": 10000, "max_age": 86400, "source": "all" }, "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": "ai_search_model", "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": "embedding_model", "enable": true, "engine_version": 0, "fusion_method": "max", "hybrid_search_enabled": true, "index_method": { "keyword": true, "vector": true }, "indexing_options": { "keyword_tokenizer": "porter", "use_ocr": true }, "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 }, "custom_domains": [ "search.example.com" ], "default_domain_enabled": 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": "reranking_model", "retrieval_options": { "boost_by": [ { "field": "timestamp", "direction": "desc" } ], "keyword_match_mode": "and" }, "rewrite_model": "rewrite_model", "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": { "discover_options": { "depth": 5, "include_external_links": false, "include_subdomains": false, "limit": 10000, "max_age": 86400, "source": "all" }, "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 } ```