--- title: List AI Search instances. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [AI Search](https://developers.cloudflare.com/api/resources/ai_search) [Instances](https://developers.cloudflare.com/api/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 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
##### P ath ParametersExpand Collapse account\_id: string [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse hostname: optional string Filter by exact Search for Agents hostname (case-insensitive). maxLength253 minLength1 [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20hostname%20%3E%20(schema)>) namespace: optional string Filter by namespace. [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20namespace%20%3E%20(schema)>) order\_by: optional "created\_at" Field to order results by. [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order_by%20%3E%20(schema)>)
order\_by\_direction: optional "asc"or "desc" Order direction. One of the following: "asc" Link to this property "desc" Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order_by_direction%20%3E%20(schema)>) page: optional number Page number (1-indexed). minimum1 [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: optional number Number of results per page. maximum100 minimum1 [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) search: optional string Filter instances whose id contains this string (case-insensitive). maxLength64 [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20search%20%3E%20(schema)>) ##### ReturnsExpand Collapse
result: array of object {id, ai\_gateway\_id, ai\_search\_model, 42 more } id: string Link to this property ai\_gateway\_id: string Link to this property ai\_search\_model: string Link to this property cache: boolean Link to this property
cache\_threshold: "super\_strict\_match"or "close\_enough"or "flexible\_friend"or "anything\_goes" One of the following: "super\_strict\_match" Link to this property "close\_enough" Link to this property "flexible\_friend" Link to this property "anything\_goes" Link to this property
Link to this property
cache\_ttl: 600or 1800or 3600or 7 more One of the following: 600 Link to this property 1800 Link to this property 3600 Link to this property 7200 Link to this property 21600 Link to this property 43200 Link to this property 86400 Link to this property 172800 Link to this property 259200 Link to this property 518400 Link to this property
Link to this property chunk: boolean Link to this property chunk\_overlap: number Link to this property chunk\_size: number Link to this property created\_at: string formatdate-time Link to this property created\_by: string Link to this property
custom\_metadata: array of object {data\_type, field\_name }
data\_type: "text"or "number"or "boolean"or "datetime" One of the following: "text" Link to this property "number" Link to this property "boolean" Link to this property "datetime" Link to this property
Link to this property field\_name: string Link to this property
Link to this property embedding\_model: string Link to this property enable: boolean Link to this property engine\_version: number Link to this property
fusion\_method: "max"or "rrf" One of the following: "max" Link to this property "rrf" Link to this property
Link to this property hybrid\_search\_enabled: boolean Link to this property
index\_method: object {keyword, vector } keyword: boolean Link to this property vector: boolean Link to this property
Link to this property
indexing\_options: object {keyword\_tokenizer, use\_ocr }
keyword\_tokenizer: optional "porter"or "trigram" One of the following: "porter" Link to this property "trigram" Link to this property
Link to this property use\_ocr: optional boolean Link to this property
Link to this property last\_activity: string formatdate-time Link to this property max\_num\_results: number Link to this property
metadata: object {created\_from\_aisearch\_wizard, worker\_domain } created\_from\_aisearch\_wizard: optional boolean Link to this property worker\_domain: optional string Link to this property
Link to this property modified\_at: string formatdate-time Link to this property modified\_by: string Link to this property namespace: string Link to this property paused: boolean Link to this property public\_endpoint\_id: string Link to this property
public\_endpoint\_params: object {authorized\_hosts, chat\_completions\_endpoint, custom\_domains, 5 more } authorized\_hosts: optional array of string Link to this property
chat\_completions\_endpoint: optional object {disabled } disabled: optional boolean Link to this property
Link to this property custom\_domains: optional array of string Link to this property default\_domain\_enabled: optional boolean Link to this property enabled: optional boolean Link to this property
mcp: optional object {description, disabled } description: optional string Link to this property disabled: optional boolean Link to this property
Link to this property
rate\_limit: optional object {period\_ms, requests, technique } period\_ms: optional number maximum3600000 minimum60000 Link to this property requests: optional number minimum1 Link to this property
technique: optional "fixed"or "sliding" One of the following: "fixed" Link to this property "sliding" Link to this property
Link to this property
Link to this property
search\_endpoint: optional object {disabled } disabled: optional boolean Link to this property
Link to this property
Link to this property reranking: boolean Link to this property reranking\_model: string Link to this property
retrieval\_options: object {boost\_by, keyword\_match\_mode }
boost\_by: optional array of object {field, dataType, direction } field: string maxLength64 minLength1 Link to this property
dataType: optional "number"or "datetime"or "text"or "boolean" One of the following: "number" Link to this property "datetime" Link to this property "text" Link to this property "boolean" Link to this property
Link to this property
direction: optional "asc"or "desc"or "exists"or "not\_exists" One of the following: "asc" Link to this property "desc" Link to this property "exists" Link to this property "not\_exists" Link to this property
Link to this property
Link to this property
keyword\_match\_mode: optional "and"or "or" One of the following: "and" Link to this property "or" Link to this property
Link to this property
Link to this property rewrite\_model: string Link to this property rewrite\_query: boolean Link to this property score\_threshold: number Link to this property source: string Link to this property
source\_params: object {exclude\_items, include\_items, prefix, 2 more } exclude\_items: optional array of string Link to this property include\_items: optional array of string Link to this property prefix: optional string Link to this property r2\_jurisdiction: optional string Link to this property
web\_crawler: optional object {discover\_options, parse\_options, parse\_type }
discover\_options: optional object {depth, include\_external\_links, include\_subdomains, 3 more } depth: optional number maximum100000 minimum1 Link to this property include\_external\_links: optional boolean Link to this property include\_subdomains: optional boolean Link to this property limit: optional number 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 max\_age: optional number maximum604800 minimum0 Link to this property
source: optional "all"or "sitemaps"or "links" One of the following: "all" Link to this property "sitemaps" Link to this property "links" Link to this property
Link to this property
Link to this property
parse\_options: optional object {content\_selector, include\_headers, include\_images, 2 more }
content\_selector: optional array of object {path, selector } path: string maxLength200 minLength1 Link to this property selector: string maxLength200 minLength1 Link to this property
Link to this property include\_headers: optional map\[string] Link to this property include\_images: optional boolean Link to this property specific\_sitemaps: optional array of string Link to this property use\_browser\_rendering: optional boolean Link to this property
Link to this property
parse\_type: optional "sitemap"or "discover" One of the following: "sitemap" Link to this property "discover" Link to this property
Link to this property
Link to this property
Link to this property status: string Link to this property summarization: boolean Link to this property summarization\_model: string Link to this property
sync\_interval: 900or 1800or 3600or 5 more One of the following: 900 Link to this property 1800 Link to this property 3600 Link to this property 7200 Link to this property 14400 Link to this property 21600 Link to this property 43200 Link to this property 86400 Link to this property
Link to this property system\_prompt\_ai\_search: string Link to this property system\_prompt\_index\_summarization: string Link to this property system\_prompt\_rewrite\_query: string Link to this property token\_id: string Link to this property
type: "r2"or "web-crawler" One of the following: "r2" Link to this property "web-crawler" Link to this property
Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
result\_info: object {count, page, per\_page, total\_count } count: number Link to this property page: number Link to this property per\_page: number Link to this property total\_count: number Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>) success: true [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>) ### List AI Search instances. HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai-search/instances \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 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 } ```