--- title: List AI Search instances. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [AI Search](https://developers.cloudflare.com/api/python/resources/ai_search) [Instances](https://developers.cloudflare.com/api/python/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 aisearch.instances.list(InstanceListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[InstanceListResponse]()] 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 account\_id: str [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)>) hostname: Optional\[str] 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\[str] 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\[Literal\["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\[Literal\["asc", "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\[int] 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\[int] 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\[str] 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

class InstanceListResponse: …

id: str Link to this property ai\_gateway\_id: Optional\[str] Link to this property aisearch\_model: Optional\[str] Link to this property cache: bool Link to this property

cache\_threshold: Optional\[Literal\["super\_strict\_match", "close\_enough", "flexible\_friend", "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: Literal\[600, 1800, 3600, 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: bool Link to this property chunk\_overlap: Optional\[float] Link to this property chunk\_size: Optional\[float] Link to this property created\_at: datetime formatdate-time Link to this property created\_by: Optional\[str] Link to this property

custom\_metadata: Optional\[List\[CustomMetadata]]

data\_type: Literal\["text", "number", "boolean", "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: str Link to this property

Link to this property embedding\_model: Optional\[str] Link to this property enable: bool Link to this property engine\_version: float Link to this property

fusion\_method: Literal\["max", "rrf"]

One of the following: "max" Link to this property "rrf" Link to this property

Link to this property hybrid\_search\_enabled: bool Link to this property

index\_method: IndexMethod

keyword: bool Link to this property vector: bool Link to this property

Link to this property

indexing\_options: Optional\[IndexingOptions]

keyword\_tokenizer: Optional\[Literal\["porter", "trigram"]]

One of the following: "porter" Link to this property "trigram" Link to this property

Link to this property use\_ocr: Optional\[bool] Link to this property

Link to this property last\_activity: Optional\[datetime] formatdate-time Link to this property max\_num\_results: Optional\[float] Link to this property

metadata: Optional\[Metadata]

created\_from\_aisearch\_wizard: Optional\[bool] Link to this property worker\_domain: Optional\[str] Link to this property

Link to this property modified\_at: datetime formatdate-time Link to this property modified\_by: Optional\[str] Link to this property namespace: str Link to this property paused: bool Link to this property public\_endpoint\_id: Optional\[str] Link to this property

public\_endpoint\_params: Optional\[PublicEndpointParams]

authorized\_hosts: Optional\[List\[str]] Link to this property

chat\_completions\_endpoint: Optional\[PublicEndpointParamsChatCompletionsEndpoint]

disabled: Optional\[bool] Link to this property

Link to this property custom\_domains: Optional\[List\[str]] Link to this property default\_domain\_enabled: Optional\[bool] Link to this property enabled: Optional\[bool] Link to this property

mcp: Optional\[PublicEndpointParamsMcp]

description: Optional\[str] Link to this property disabled: Optional\[bool] Link to this property

Link to this property

rate\_limit: Optional\[PublicEndpointParamsRateLimit]

period\_ms: Optional\[int] maximum3600000 minimum60000 Link to this property requests: Optional\[int] minimum1 Link to this property

technique: Optional\[Literal\["fixed", "sliding"]]

One of the following: "fixed" Link to this property "sliding" Link to this property

Link to this property

search\_endpoint: Optional\[PublicEndpointParamsSearchEndpoint]

disabled: Optional\[bool] Link to this property

Link to this property

Link to this property reranking: bool Link to this property reranking\_model: Optional\[str] Link to this property

retrieval\_options: Optional\[RetrievalOptions]

boost\_by: Optional\[List\[RetrievalOptionsBoostBy]]

field: str maxLength64 minLength1 Link to this property

data\_type: Optional\[Literal\["number", "datetime", "text", "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\[Literal\["asc", "desc", "exists", "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

keyword\_match\_mode: Optional\[Literal\["and", "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: Optional\[str] Link to this property rewrite\_query: bool Link to this property score\_threshold: Optional\[float] Link to this property source: Optional\[str] Link to this property

source\_params: Optional\[SourceParams]

exclude\_items: Optional\[List\[str]] Link to this property include\_items: Optional\[List\[str]] Link to this property prefix: Optional\[str] Link to this property r2\_jurisdiction: Optional\[str] Link to this property

web\_crawler: Optional\[SourceParamsWebCrawler]

discover\_options: Optional\[SourceParamsWebCrawlerDiscoverOptions]

depth: Optional\[float] maximum100000 minimum1 Link to this property include\_external\_links: Optional\[bool] Link to this property include\_subdomains: Optional\[bool] Link to this property limit: Optional\[float] 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\[float] maximum604800 minimum0 Link to this property

source: Optional\[Literal\["all", "sitemaps", "links"]]

One of the following: "all" Link to this property "sitemaps" Link to this property "links" Link to this property

Link to this property

parse\_options: Optional\[SourceParamsWebCrawlerParseOptions]

content\_selector: Optional\[List\[SourceParamsWebCrawlerParseOptionsContentSelector]]

path: str maxLength200 minLength1 Link to this property selector: str maxLength200 minLength1 Link to this property

Link to this property include\_headers: Optional\[Dict\[str, str]] Link to this property include\_images: Optional\[bool] Link to this property specific\_sitemaps: Optional\[List\[str]] Link to this property use\_browser\_rendering: Optional\[bool] Link to this property

Link to this property

parse\_type: Optional\[Literal\["sitemap", "discover"]]

One of the following: "sitemap" Link to this property "discover" Link to this property

Link to this property

Link to this property status: str Link to this property summarization: bool Link to this property summarization\_model: Optional\[str] Link to this property

sync\_interval: Literal\[900, 1800, 3600, 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\_aisearch: Optional\[str] Link to this property system\_prompt\_index\_summarization: Optional\[str] Link to this property system\_prompt\_rewrite\_query: Optional\[str] Link to this property token\_id: Optional\[str] Link to this property

type: Optional\[Literal\["r2", "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(model)%20instance_list_response%20%3E%20(schema)>) ### List AI Search instances. Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.aisearch.instances.list( account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22", ) page = page.result[0] print(page.id) ``` 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 } ```