--- title: Get an AI Search instance. --- [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** # Get an AI Search instance. Deprecated client.AISearch.Instances.Read(ctx, id, query) (\*[InstanceReadResponse](), error) GET/accounts/{account\_id}/ai-search/instances/{id} Retrieve the configuration and status of an AI Search instance. 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)%20read%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>)
query InstanceReadParams AccountID param.Field\[string] Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20read%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type InstanceReadResponse 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 InstanceReadResponseCacheThresholdOptional One of the following: const InstanceReadResponseCacheThresholdSuperStrictMatch InstanceReadResponseCacheThreshold = "super\_strict\_match" Link to this property const InstanceReadResponseCacheThresholdCloseEnough InstanceReadResponseCacheThreshold = "close\_enough" Link to this property const InstanceReadResponseCacheThresholdFlexibleFriend InstanceReadResponseCacheThreshold = "flexible\_friend" Link to this property const InstanceReadResponseCacheThresholdAnythingGoes InstanceReadResponseCacheThreshold = "anything\_goes" Link to this property
Link to this property
CacheTTL InstanceReadResponseCacheTTLOptional 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 InstanceReadResponseCacheTTL600 InstanceReadResponseCacheTTL = 600 Link to this property const InstanceReadResponseCacheTTL1800 InstanceReadResponseCacheTTL = 1800 Link to this property const InstanceReadResponseCacheTTL3600 InstanceReadResponseCacheTTL = 3600 Link to this property const InstanceReadResponseCacheTTL7200 InstanceReadResponseCacheTTL = 7200 Link to this property const InstanceReadResponseCacheTTL21600 InstanceReadResponseCacheTTL = 21600 Link to this property const InstanceReadResponseCacheTTL43200 InstanceReadResponseCacheTTL = 43200 Link to this property const InstanceReadResponseCacheTTL86400 InstanceReadResponseCacheTTL = 86400 Link to this property const InstanceReadResponseCacheTTL172800 InstanceReadResponseCacheTTL = 172800 Link to this property const InstanceReadResponseCacheTTL259200 InstanceReadResponseCacheTTL = 259200 Link to this property const InstanceReadResponseCacheTTL518400 InstanceReadResponseCacheTTL = 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 \[]InstanceReadResponseCustomMetadataOptional
DataType InstanceReadResponseCustomMetadataDataType One of the following: const InstanceReadResponseCustomMetadataDataTypeText InstanceReadResponseCustomMetadataDataType = "text" Link to this property const InstanceReadResponseCustomMetadataDataTypeNumber InstanceReadResponseCustomMetadataDataType = "number" Link to this property const InstanceReadResponseCustomMetadataDataTypeBoolean InstanceReadResponseCustomMetadataDataType = "boolean" Link to this property const InstanceReadResponseCustomMetadataDataTypeDatetime InstanceReadResponseCustomMetadataDataType = "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 InstanceReadResponseFusionMethodOptional One of the following: const InstanceReadResponseFusionMethodMax InstanceReadResponseFusionMethod = "max" Link to this property const InstanceReadResponseFusionMethodRrf InstanceReadResponseFusionMethod = "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 InstanceReadResponseIndexMethodOptional 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 InstanceReadResponseIndexingOptionsOptional
KeywordTokenizer InstanceReadResponseIndexingOptionsKeywordTokenizerOptional 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 InstanceReadResponseIndexingOptionsKeywordTokenizerPorter InstanceReadResponseIndexingOptionsKeywordTokenizer = "porter" Link to this property const InstanceReadResponseIndexingOptionsKeywordTokenizerTrigram InstanceReadResponseIndexingOptionsKeywordTokenizer = "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 InstanceReadResponseMetadataOptional 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 InstanceReadResponsePublicEndpointParamsOptional AuthorizedHosts \[]stringOptional Link to this property
ChatCompletionsEndpoint InstanceReadResponsePublicEndpointParamsChatCompletionsEndpointOptional 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 InstanceReadResponsePublicEndpointParamsMcpOptional Description stringOptional Link to this property Disabled boolOptional Disable MCP endpoint for this public endpoint Link to this property
Link to this property
RateLimit InstanceReadResponsePublicEndpointParamsRateLimitOptional PeriodMs int64Optional maximum3600000 minimum60000 Link to this property Requests int64Optional minimum1 Link to this property
Technique InstanceReadResponsePublicEndpointParamsRateLimitTechniqueOptional One of the following: const InstanceReadResponsePublicEndpointParamsRateLimitTechniqueFixed InstanceReadResponsePublicEndpointParamsRateLimitTechnique = "fixed" Link to this property const InstanceReadResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceReadResponsePublicEndpointParamsRateLimitTechnique = "sliding" Link to this property
Link to this property
Link to this property
SearchEndpoint InstanceReadResponsePublicEndpointParamsSearchEndpointOptional 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 InstanceReadResponseRetrievalOptionsOptional
BoostBy \[]InstanceReadResponseRetrievalOptionsBoostByOptional 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 InstanceReadResponseRetrievalOptionsBoostByDirectionOptional 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 InstanceReadResponseRetrievalOptionsBoostByDirectionAsc InstanceReadResponseRetrievalOptionsBoostByDirection = "asc" Link to this property const InstanceReadResponseRetrievalOptionsBoostByDirectionDesc InstanceReadResponseRetrievalOptionsBoostByDirection = "desc" Link to this property const InstanceReadResponseRetrievalOptionsBoostByDirectionExists InstanceReadResponseRetrievalOptionsBoostByDirection = "exists" Link to this property const InstanceReadResponseRetrievalOptionsBoostByDirectionNotExists InstanceReadResponseRetrievalOptionsBoostByDirection = "not\_exists" Link to this property
Link to this property
Link to this property
KeywordMatchMode InstanceReadResponseRetrievalOptionsKeywordMatchModeOptional 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 InstanceReadResponseRetrievalOptionsKeywordMatchModeAnd InstanceReadResponseRetrievalOptionsKeywordMatchMode = "and" Link to this property const InstanceReadResponseRetrievalOptionsKeywordMatchModeOr InstanceReadResponseRetrievalOptionsKeywordMatchMode = "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 InstanceReadResponseSourceParamsOptional 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 InstanceReadResponseSourceParamsWebCrawlerOptional
DiscoverOptions InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsOptional 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 InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsSourceOptional Where the crawler looks for URLs: ‘sitemaps’ reads sitemap XML only, ‘links’ follows page links only, ‘all’ does both. One of the following: const InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsSourceAll InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsSource = "all" Link to this property const InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsSourceSitemaps InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsSource = "sitemaps" Link to this property const InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsSourceLinks InstanceReadResponseSourceParamsWebCrawlerDiscoverOptionsSource = "links" Link to this property
Link to this property
Link to this property
ParseOptions InstanceReadResponseSourceParamsWebCrawlerParseOptionsOptional
ContentSelector \[]InstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelectorOptional 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 InstanceReadResponseSourceParamsWebCrawlerParseTypeOptional 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 InstanceReadResponseSourceParamsWebCrawlerParseTypeSitemap InstanceReadResponseSourceParamsWebCrawlerParseType = "sitemap" Link to this property const InstanceReadResponseSourceParamsWebCrawlerParseTypeDiscover InstanceReadResponseSourceParamsWebCrawlerParseType = "discover" Link to this property
Link to this property
Link to this property
Link to this property Status stringOptional Link to this property
SyncInterval InstanceReadResponseSyncIntervalOptional 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 InstanceReadResponseSyncInterval900 InstanceReadResponseSyncInterval = 900 Link to this property const InstanceReadResponseSyncInterval1800 InstanceReadResponseSyncInterval = 1800 Link to this property const InstanceReadResponseSyncInterval3600 InstanceReadResponseSyncInterval = 3600 Link to this property const InstanceReadResponseSyncInterval7200 InstanceReadResponseSyncInterval = 7200 Link to this property const InstanceReadResponseSyncInterval14400 InstanceReadResponseSyncInterval = 14400 Link to this property const InstanceReadResponseSyncInterval21600 InstanceReadResponseSyncInterval = 21600 Link to this property const InstanceReadResponseSyncInterval43200 InstanceReadResponseSyncInterval = 43200 Link to this property const InstanceReadResponseSyncInterval86400 InstanceReadResponseSyncInterval = 86400 Link to this property
Link to this property TokenID stringOptional formatuuid Link to this property
Type InstanceReadResponseTypeOptional 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 InstanceReadResponseTypeR2 InstanceReadResponseType = "r2" Link to this property const InstanceReadResponseTypeWebCrawler InstanceReadResponseType = "web-crawler" Link to this property
Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20InstanceReadResponse%20%3E%20(schema)>) ### Get an AI Search instance. 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"), ) response, err := client.AISearch.Instances.Read( context.TODO(), "my-ai-search", ai_search.InstanceReadParams{ AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.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 } ```