List AI Search instances.
aisearch.instances.list(InstanceListParams**kwargs) -> SyncV4PagePaginationArray[InstanceListResponse]
GET/accounts/{account_id}/ai-search/instances
List all AI Search instances in the account.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Parameters
List AI Search instances.
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){
"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"
},
"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
{
"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"
},
"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
}