--- title: List AI Search instances. --- [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** # List AI Search instances. Deprecated client.AISearch.Instances.List(ctx, params) (\*V4PagePaginationArray\[[InstanceListResponse]()], error) GET/accounts/{account\_id}/ai-search/instances List all AI Search instances in the account. 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
params InstanceListParams AccountID param.Field\[string] Path param Link to this property Hostname param.Field\[string]Optional Query param: Filter by exact Search for Agents hostname (case-insensitive). maxLength253 minLength1 Link to this property Namespace param.Field\[string]Optional Query param: Filter by namespace. Link to this property
OrderBy param.Field\[InstanceListParamsOrderBy]Optional Query param: Field to order results by. const InstanceListParamsOrderByCreatedAt InstanceListParamsOrderBy = "created\_at" Link to this property
Link to this property
OrderByDirection param.Field\[InstanceListParamsOrderByDirection]Optional Query param: Order direction. const InstanceListParamsOrderByDirectionAsc InstanceListParamsOrderByDirection = "asc" Link to this property const InstanceListParamsOrderByDirectionDesc InstanceListParamsOrderByDirection = "desc" Link to this property
Link to this property Page param.Field\[int64]Optional Query param: Page number (1-indexed). minimum1 Link to this property PerPage param.Field\[int64]Optional Query param: Number of results per page. maximum100 minimum1 Link to this property Search param.Field\[string]Optional Query param: Filter instances whose id contains this string (case-insensitive). maxLength64 Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type InstanceListResponse struct{…} ID string Link to this property AIGatewayID string Link to this property AISearchModel string Link to this property Cache bool Link to this property
CacheThreshold InstanceListResponseCacheThreshold One of the following: const InstanceListResponseCacheThresholdSuperStrictMatch InstanceListResponseCacheThreshold = "super\_strict\_match" Link to this property const InstanceListResponseCacheThresholdCloseEnough InstanceListResponseCacheThreshold = "close\_enough" Link to this property const InstanceListResponseCacheThresholdFlexibleFriend InstanceListResponseCacheThreshold = "flexible\_friend" Link to this property const InstanceListResponseCacheThresholdAnythingGoes InstanceListResponseCacheThreshold = "anything\_goes" Link to this property
Link to this property
CacheTTL InstanceListResponseCacheTTL One of the following: const InstanceListResponseCacheTTL600 InstanceListResponseCacheTTL = 600 Link to this property const InstanceListResponseCacheTTL1800 InstanceListResponseCacheTTL = 1800 Link to this property const InstanceListResponseCacheTTL3600 InstanceListResponseCacheTTL = 3600 Link to this property const InstanceListResponseCacheTTL7200 InstanceListResponseCacheTTL = 7200 Link to this property const InstanceListResponseCacheTTL21600 InstanceListResponseCacheTTL = 21600 Link to this property const InstanceListResponseCacheTTL43200 InstanceListResponseCacheTTL = 43200 Link to this property const InstanceListResponseCacheTTL86400 InstanceListResponseCacheTTL = 86400 Link to this property const InstanceListResponseCacheTTL172800 InstanceListResponseCacheTTL = 172800 Link to this property const InstanceListResponseCacheTTL259200 InstanceListResponseCacheTTL = 259200 Link to this property const InstanceListResponseCacheTTL518400 InstanceListResponseCacheTTL = 518400 Link to this property
Link to this property Chunk bool Link to this property ChunkOverlap float64 Link to this property ChunkSize float64 Link to this property CreatedAt Time formatdate-time Link to this property CreatedBy string Link to this property
CustomMetadata \[]InstanceListResponseCustomMetadata
DataType InstanceListResponseCustomMetadataDataType One of the following: const InstanceListResponseCustomMetadataDataTypeText InstanceListResponseCustomMetadataDataType = "text" Link to this property const InstanceListResponseCustomMetadataDataTypeNumber InstanceListResponseCustomMetadataDataType = "number" Link to this property const InstanceListResponseCustomMetadataDataTypeBoolean InstanceListResponseCustomMetadataDataType = "boolean" Link to this property const InstanceListResponseCustomMetadataDataTypeDatetime InstanceListResponseCustomMetadataDataType = "datetime" Link to this property
Link to this property FieldName string Link to this property
Link to this property EmbeddingModel string Link to this property Enable bool Link to this property EngineVersion float64 Link to this property
FusionMethod InstanceListResponseFusionMethod One of the following: const InstanceListResponseFusionMethodMax InstanceListResponseFusionMethod = "max" Link to this property const InstanceListResponseFusionMethodRrf InstanceListResponseFusionMethod = "rrf" Link to this property
Link to this property HybridSearchEnabled bool Link to this property
IndexMethod InstanceListResponseIndexMethod Keyword bool Link to this property Vector bool Link to this property
Link to this property
IndexingOptions InstanceListResponseIndexingOptions
KeywordTokenizer InstanceListResponseIndexingOptionsKeywordTokenizerOptional One of the following: const InstanceListResponseIndexingOptionsKeywordTokenizerPorter InstanceListResponseIndexingOptionsKeywordTokenizer = "porter" Link to this property const InstanceListResponseIndexingOptionsKeywordTokenizerTrigram InstanceListResponseIndexingOptionsKeywordTokenizer = "trigram" Link to this property
Link to this property UseOCR boolOptional Link to this property
Link to this property LastActivity Time formatdate-time Link to this property MaxNumResults float64 Link to this property
Metadata InstanceListResponseMetadata CreatedFromAISearchWizard boolOptional Link to this property WorkerDomain stringOptional Link to this property
Link to this property ModifiedAt Time formatdate-time Link to this property ModifiedBy string Link to this property Namespace string Link to this property Paused bool Link to this property PublicEndpointID string Link to this property
PublicEndpointParams InstanceListResponsePublicEndpointParams AuthorizedHosts \[]stringOptional Link to this property
ChatCompletionsEndpoint InstanceListResponsePublicEndpointParamsChatCompletionsEndpointOptional Disabled boolOptional Link to this property
Link to this property CustomDomains \[]stringOptional Link to this property DefaultDomainEnabled boolOptional Link to this property Enabled boolOptional Link to this property
Mcp InstanceListResponsePublicEndpointParamsMcpOptional Description stringOptional Link to this property Disabled boolOptional Link to this property
Link to this property
RateLimit InstanceListResponsePublicEndpointParamsRateLimitOptional PeriodMs int64Optional maximum3600000 minimum60000 Link to this property Requests int64Optional minimum1 Link to this property
Technique InstanceListResponsePublicEndpointParamsRateLimitTechniqueOptional One of the following: const InstanceListResponsePublicEndpointParamsRateLimitTechniqueFixed InstanceListResponsePublicEndpointParamsRateLimitTechnique = "fixed" Link to this property const InstanceListResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceListResponsePublicEndpointParamsRateLimitTechnique = "sliding" Link to this property
Link to this property
Link to this property
SearchEndpoint InstanceListResponsePublicEndpointParamsSearchEndpointOptional Disabled boolOptional Link to this property
Link to this property
Link to this property Reranking bool Link to this property RerankingModel string Link to this property
RetrievalOptions InstanceListResponseRetrievalOptions
BoostBy \[]InstanceListResponseRetrievalOptionsBoostByOptional Field string maxLength64 minLength1 Link to this property
DataType InstanceListResponseRetrievalOptionsBoostByDataTypeOptional One of the following: const InstanceListResponseRetrievalOptionsBoostByDataTypeNumber InstanceListResponseRetrievalOptionsBoostByDataType = "number" Link to this property const InstanceListResponseRetrievalOptionsBoostByDataTypeDatetime InstanceListResponseRetrievalOptionsBoostByDataType = "datetime" Link to this property const InstanceListResponseRetrievalOptionsBoostByDataTypeText InstanceListResponseRetrievalOptionsBoostByDataType = "text" Link to this property const InstanceListResponseRetrievalOptionsBoostByDataTypeBoolean InstanceListResponseRetrievalOptionsBoostByDataType = "boolean" Link to this property
Link to this property
Direction InstanceListResponseRetrievalOptionsBoostByDirectionOptional One of the following: const InstanceListResponseRetrievalOptionsBoostByDirectionAsc InstanceListResponseRetrievalOptionsBoostByDirection = "asc" Link to this property const InstanceListResponseRetrievalOptionsBoostByDirectionDesc InstanceListResponseRetrievalOptionsBoostByDirection = "desc" Link to this property const InstanceListResponseRetrievalOptionsBoostByDirectionExists InstanceListResponseRetrievalOptionsBoostByDirection = "exists" Link to this property const InstanceListResponseRetrievalOptionsBoostByDirectionNotExists InstanceListResponseRetrievalOptionsBoostByDirection = "not\_exists" Link to this property
Link to this property
Link to this property
KeywordMatchMode InstanceListResponseRetrievalOptionsKeywordMatchModeOptional One of the following: const InstanceListResponseRetrievalOptionsKeywordMatchModeAnd InstanceListResponseRetrievalOptionsKeywordMatchMode = "and" Link to this property const InstanceListResponseRetrievalOptionsKeywordMatchModeOr InstanceListResponseRetrievalOptionsKeywordMatchMode = "or" Link to this property
Link to this property
Link to this property RewriteModel string Link to this property RewriteQuery bool Link to this property ScoreThreshold float64 Link to this property Source string Link to this property
SourceParams InstanceListResponseSourceParams ExcludeItems \[]stringOptional Link to this property IncludeItems \[]stringOptional Link to this property Prefix stringOptional Link to this property R2Jurisdiction stringOptional Link to this property
WebCrawler InstanceListResponseSourceParamsWebCrawlerOptional
DiscoverOptions InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsOptional Depth float64Optional maximum100000 minimum1 Link to this property IncludeExternalLinks boolOptional Link to this property IncludeSubdomains boolOptional Link to this property Limit float64Optional Maximum number of pages to crawl. New values are capped at 100000; instances configured before that cap may report a higher stored value, which the crawler clamps at run time. maximum100000 minimum1 Link to this property MaxAge float64Optional maximum604800 minimum0 Link to this property
Source InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceOptional One of the following: const InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceAll InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSource = "all" Link to this property const InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceSitemaps InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSource = "sitemaps" Link to this property const InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceLinks InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSource = "links" Link to this property
Link to this property
Link to this property
ParseOptions InstanceListResponseSourceParamsWebCrawlerParseOptionsOptional
ContentSelector \[]InstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelectorOptional Path string maxLength200 minLength1 Link to this property Selector string maxLength200 minLength1 Link to this property
Link to this property IncludeHeaders map\[string, string]Optional Link to this property IncludeImages boolOptional Link to this property SpecificSitemaps \[]stringOptional Link to this property UseBrowserRendering boolOptional Link to this property
Link to this property
ParseType InstanceListResponseSourceParamsWebCrawlerParseTypeOptional One of the following: const InstanceListResponseSourceParamsWebCrawlerParseTypeSitemap InstanceListResponseSourceParamsWebCrawlerParseType = "sitemap" Link to this property const InstanceListResponseSourceParamsWebCrawlerParseTypeDiscover InstanceListResponseSourceParamsWebCrawlerParseType = "discover" Link to this property
Link to this property
Link to this property
Link to this property Status string Link to this property Summarization bool Link to this property SummarizationModel string Link to this property
SyncInterval InstanceListResponseSyncInterval One of the following: const InstanceListResponseSyncInterval900 InstanceListResponseSyncInterval = 900 Link to this property const InstanceListResponseSyncInterval1800 InstanceListResponseSyncInterval = 1800 Link to this property const InstanceListResponseSyncInterval3600 InstanceListResponseSyncInterval = 3600 Link to this property const InstanceListResponseSyncInterval7200 InstanceListResponseSyncInterval = 7200 Link to this property const InstanceListResponseSyncInterval14400 InstanceListResponseSyncInterval = 14400 Link to this property const InstanceListResponseSyncInterval21600 InstanceListResponseSyncInterval = 21600 Link to this property const InstanceListResponseSyncInterval43200 InstanceListResponseSyncInterval = 43200 Link to this property const InstanceListResponseSyncInterval86400 InstanceListResponseSyncInterval = 86400 Link to this property
Link to this property SystemPromptAISearch string Link to this property SystemPromptIndexSummarization string Link to this property SystemPromptRewriteQuery string Link to this property TokenID string Link to this property
Type InstanceListResponseType One of the following: const InstanceListResponseTypeR2 InstanceListResponseType = "r2" Link to this property const InstanceListResponseTypeWebCrawler InstanceListResponseType = "web-crawler" Link to this property
Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20InstanceListResponse%20%3E%20(schema)>) ### List AI Search instances. 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"), ) page, err := client.AISearch.Instances.List(context.TODO(), ai_search.InstanceListParams{ AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 200 example ``` { "result": [ { "id": "id", "ai_gateway_id": "ai_gateway_id", "ai_search_model": "ai_search_model", "cache": true, "cache_threshold": "super_strict_match", "cache_ttl": 600, "chunk": true, "chunk_overlap": 0, "chunk_size": 0, "created_at": "2019-12-27T18:11:19.117Z", "created_by": "created_by", "custom_metadata": [ { "data_type": "text", "field_name": "field_name" } ], "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": 0, "metadata": { "created_from_aisearch_wizard": true, "worker_domain": "worker_domain" }, "modified_at": "2019-12-27T18:11:19.117Z", "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": [ "x" ], "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": "x", "dataType": "number", "direction": "asc" } ], "keyword_match_mode": "and" }, "rewrite_model": "rewrite_model", "rewrite_query": true, "score_threshold": 0, "source": "source", "source_params": { "exclude_items": [ "string" ], "include_items": [ "string" ], "prefix": "prefix", "r2_jurisdiction": "r2_jurisdiction", "web_crawler": { "discover_options": { "depth": 1, "include_external_links": true, "include_subdomains": true, "limit": 1, "max_age": 0, "source": "all" }, "parse_options": { "content_selector": [ { "path": "x", "selector": "x" } ], "include_headers": { "foo": "string" }, "include_images": true, "specific_sitemaps": [ "https://example.com" ], "use_browser_rendering": true }, "parse_type": "sitemap" } }, "status": "status", "summarization": true, "summarization_model": "summarization_model", "sync_interval": 900, "system_prompt_ai_search": "system_prompt_ai_search", "system_prompt_index_summarization": "system_prompt_index_summarization", "system_prompt_rewrite_query": "system_prompt_rewrite_query", "token_id": "token_id", "type": "r2" } ], "result_info": { "count": 0, "page": 0, "per_page": 0, "total_count": 0 }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": [ { "id": "id", "ai_gateway_id": "ai_gateway_id", "ai_search_model": "ai_search_model", "cache": true, "cache_threshold": "super_strict_match", "cache_ttl": 600, "chunk": true, "chunk_overlap": 0, "chunk_size": 0, "created_at": "2019-12-27T18:11:19.117Z", "created_by": "created_by", "custom_metadata": [ { "data_type": "text", "field_name": "field_name" } ], "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": 0, "metadata": { "created_from_aisearch_wizard": true, "worker_domain": "worker_domain" }, "modified_at": "2019-12-27T18:11:19.117Z", "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": [ "x" ], "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": "x", "dataType": "number", "direction": "asc" } ], "keyword_match_mode": "and" }, "rewrite_model": "rewrite_model", "rewrite_query": true, "score_threshold": 0, "source": "source", "source_params": { "exclude_items": [ "string" ], "include_items": [ "string" ], "prefix": "prefix", "r2_jurisdiction": "r2_jurisdiction", "web_crawler": { "discover_options": { "depth": 1, "include_external_links": true, "include_subdomains": true, "limit": 1, "max_age": 0, "source": "all" }, "parse_options": { "content_selector": [ { "path": "x", "selector": "x" } ], "include_headers": { "foo": "string" }, "include_images": true, "specific_sitemaps": [ "https://example.com" ], "use_browser_rendering": true }, "parse_type": "sitemap" } }, "status": "status", "summarization": true, "summarization_model": "summarization_model", "sync_interval": 900, "system_prompt_ai_search": "system_prompt_ai_search", "system_prompt_index_summarization": "system_prompt_index_summarization", "system_prompt_rewrite_query": "system_prompt_rewrite_query", "token_id": "token_id", "type": "r2" } ], "result_info": { "count": 0, "page": 0, "per_page": 0, "total_count": 0 }, "success": true } ```