{"openapi":"3.0.0","info":{"description":"Cloudflare AI Search REST API — managed RAG instances and namespaces with items, jobs, search and chat completions over indexed content.","version":[]},"servers":[{"description":"Cloudflare AI Search REST API — managed RAG instances and namespaces with items, jobs, search and chat completions over indexed content.","url":"https://api.apirails.com/cloudflare-ai-search"}],"paths":{"/client/v4/accounts/{account_id}/ai-search/instances":{"get":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"query","description":"Filter by namespace.","required":false,"schema":{"type":"string","example":""}},{"name":"order_by","in":"query","description":"Field to order results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["created_at"]}}},{"name":"order_by_direction","in":"query","description":"Order direction.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Page number (1-indexed).","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page.","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Filter instances whose id contains this string (case-insensitive).","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances"},"summary":"List AI Search instances","description":"List all AI Search instances in the account.","security":[{"bearerAuth":[]}]},"post":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances"},"summary":"Create an AI Search instance","description":"Create a new AI Search instance with the given configuration.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"type","enum":["r2","web-crawler"]},"ai_gateway_id":{"type":"string","description":"ai gateway id"},"ai_search_model":{"type":"string","description":"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."},"cache":{"type":"boolean","description":"cache","enum":[true,false]},"cache_threshold":{"type":"string","description":"cache threshold","enum":["super_strict_match","close_enough","flexible_friend","anything_goes"]},"cache_ttl":{"type":"string","description":"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)."},"chunk":{"type":"boolean","description":"chunk","enum":[true,false]},"chunk_overlap":{"type":"number","description":"chunk overlap"},"chunk_size":{"type":"number","description":"chunk size"},"custom_metadata":{"type":"array","description":"custom metadata","items":{"type":"object","properties":{}}},"embedding_model":{"type":"string","description":"embedding model"},"fusion_method":{"type":"string","description":"fusion method","enum":["max","rrf"]},"hybrid_search_enabled":{"type":"boolean","description":"Deprecated — use index_method instead.","enum":[true,false]},"id":{"type":"string","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true},"index_method":{"type":"object","description":"Controls which storage backends are used during indexing. Defaults to vector-only.","properties":{}},"indexing_options":{"type":"object","description":"indexing options","properties":{}},"max_num_results":{"type":"number","description":"max num results"},"metadata":{"type":"object","description":"metadata","properties":{}},"public_endpoint_params":{"type":"object","description":"public endpoint params","properties":{}},"reranking":{"type":"boolean","description":"reranking","enum":[true,false]},"reranking_model":{"type":"string","description":"reranking model"},"retrieval_options":{"type":"object","description":"retrieval options","properties":{}},"rewrite_model":{"type":"string","description":"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."},"rewrite_query":{"type":"boolean","description":"rewrite query","enum":[true,false]},"score_threshold":{"type":"number","description":"score threshold"},"source":{"type":"string","description":"source"},"source_params":{"type":"object","description":"source params","properties":{}},"sync_interval":{"type":"string","description":"Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h)."},"token_id":{"type":"string","description":"token id"}}},"example":{"type":"","ai_gateway_id":"","ai_search_model":"","cache":"","cache_threshold":"","cache_ttl":"","chunk":"","chunk_overlap":"","chunk_size":"","custom_metadata":[],"embedding_model":"","fusion_method":"","hybrid_search_enabled":"","id":"","index_method":{},"indexing_options":{},"max_num_results":"","metadata":{},"public_endpoint_params":{},"reranking":"","reranking_model":"","retrieval_options":{},"rewrite_model":"","rewrite_query":"","score_threshold":"","source":"","source_params":{},"sync_interval":"","token_id":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/instances/{id}":{"get":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}"},"summary":"Get an AI Search instance","description":"Retrieve the configuration and status of an AI Search instance.","security":[{"bearerAuth":[]}]},"put":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}"},"summary":"Update an AI Search instance","description":"Update the configuration of an AI Search instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_gateway_id":{"type":"string","description":"ai gateway id"},"ai_search_model":{"type":"string","description":"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."},"cache":{"type":"boolean","description":"cache","enum":[true,false]},"cache_threshold":{"type":"string","description":"cache threshold","enum":["super_strict_match","close_enough","flexible_friend","anything_goes"]},"cache_ttl":{"type":"string","description":"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)."},"chunk":{"type":"boolean","description":"chunk","enum":[true,false]},"chunk_overlap":{"type":"number","description":"chunk overlap"},"chunk_size":{"type":"number","description":"chunk size"},"custom_metadata":{"type":"array","description":"custom metadata","items":{"type":"object","properties":{}}},"embedding_model":{"type":"string","description":"embedding model"},"fusion_method":{"type":"string","description":"fusion method","enum":["max","rrf"]},"index_method":{"type":"object","description":"Controls which storage backends are used during indexing. Defaults to vector-only.","properties":{}},"indexing_options":{"type":"object","description":"indexing options","properties":{}},"max_num_results":{"type":"number","description":"max num results"},"metadata":{"type":"object","description":"metadata","properties":{}},"paused":{"type":"boolean","description":"paused","enum":[true,false]},"public_endpoint_params":{"type":"object","description":"public endpoint params","properties":{}},"reranking":{"type":"boolean","description":"reranking","enum":[true,false]},"reranking_model":{"type":"string","description":"reranking model"},"retrieval_options":{"type":"object","description":"retrieval options","properties":{}},"rewrite_model":{"type":"string","description":"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."},"rewrite_query":{"type":"boolean","description":"rewrite query","enum":[true,false]},"score_threshold":{"type":"number","description":"score threshold"},"source":{"type":"string","description":"source"},"source_params":{"type":"object","description":"source params","properties":{}},"summarization":{"type":"boolean","description":"summarization","enum":[true,false]},"summarization_model":{"type":"string","description":"summarization model"},"sync_interval":{"type":"string","description":"Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h)."},"system_prompt_ai_search":{"type":"string","description":"system prompt ai search"},"system_prompt_index_summarization":{"type":"string","description":"system prompt index summarization"},"system_prompt_rewrite_query":{"type":"string","description":"system prompt rewrite query"},"token_id":{"type":"string","description":"token id"}}},"example":{"ai_gateway_id":"","ai_search_model":"","cache":"","cache_threshold":"","cache_ttl":"","chunk":"","chunk_overlap":"","chunk_size":"","custom_metadata":[],"embedding_model":"","fusion_method":"","index_method":{},"indexing_options":{},"max_num_results":"","metadata":{},"paused":"","public_endpoint_params":{},"reranking":"","reranking_model":"","retrieval_options":{},"rewrite_model":"","rewrite_query":"","score_threshold":"","source":"","source_params":{},"summarization":"","summarization_model":"","sync_interval":"","system_prompt_ai_search":"","system_prompt_index_summarization":"","system_prompt_rewrite_query":"","token_id":""}}}}},"delete":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}"},"summary":"Delete an AI Search instance","description":"Permanently delete an AI Search instance and all its indexed data.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/ai-search/instances/{id}/chat/completions":{"post":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/chat/completions"},"summary":"Chat Completions","description":"Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_search_options":{"type":"object","description":"ai search options","properties":{}},"messages":{"type":"array","description":"messages","required":true,"items":{"type":"object","properties":{}}},"model":{"type":"string","description":"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."},"stream":{"type":"boolean","description":"stream","enum":[true,false]}}},"example":{"ai_search_options":{},"messages":[],"model":"","stream":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs":{"get":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs"},"summary":"List Jobs","description":"Lists indexing jobs for an AI Search instance.","security":[{"bearerAuth":[]}]},"post":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs"},"summary":"Create new job","description":"Creates a new indexing job for an AI Search instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"}}},"example":{"description":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}":{"get":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}"},"summary":"Get a Job Details","description":"Retrieves details for a specific AI Search indexing job.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}"},"summary":"Cancel an indexing job","description":"Cancel an in-progress indexing job for an AI Search instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"action","required":true,"enum":["cancel"]}}},"example":{"action":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs":{"get":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs"},"summary":"List Job Logs","description":"Lists log entries for an AI Search indexing job.","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/ai-search/instances/{id}/search":{"post":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/search"},"summary":"Search","description":"Executes a semantic search query against an AI Search instance to find relevant indexed content.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_search_options":{"type":"object","description":"ai search options","properties":{}},"messages":{"type":"array","description":"OpenAI-compatible message array. For multimodal queries, set the last user message's `content` to an array of typed parts: `[{type:'text', text:'…'}, {type:'image_url', image_url:{url:'…'}}]`. Image inputs require the RAG's embedding_model to declare 'image' in supported_modalities.","items":{"type":"object","properties":{}}},"query":{"type":"string","description":"A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both."}}},"example":{"ai_search_options":{},"messages":[],"query":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/instances/{id}/stats":{"get":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/instances/{id}/stats"},"summary":"Get instance statistics","description":"Retrieve usage and indexing statistics for an AI Search instance.","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/ai-search/namespaces":{"get":{"tags":["Namespaces"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Page number (1-indexed).","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page.","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Filter namespaces whose name or description contains this string (case-insensitive).","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces"},"summary":"List namespaces","description":"List namespaces in the account, including their descriptions and creation times.","security":[{"bearerAuth":[]}]},"post":{"tags":["Namespaces"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces"},"summary":"Create a namespace","description":"Create a namespace for organizing AI Search instances.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Optional description for the namespace. Max 256 characters."},"name":{"type":"string","description":"name","required":true},"public_endpoint_params":{"type":"object","description":"public endpoint params","properties":{}}}},"example":{"description":"","name":"","public_endpoint_params":{}}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}":{"get":{"tags":["Namespaces"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}"},"summary":"Get a namespace","description":"Retrieve a namespace and its description.","security":[{"bearerAuth":[]}]},"put":{"tags":["Namespaces"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}"},"summary":"Update a namespace","description":"Update the description and/or the public endpoint configuration of an existing namespace. The default namespace's description cannot be modified, but its public endpoint can.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Optional description for the namespace. Max 256 characters."},"public_endpoint_params":{"type":"object","description":"public endpoint params","properties":{}}}},"example":{"description":"","public_endpoint_params":{}}}}}},"delete":{"tags":["Namespaces"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}"},"summary":"Delete a namespace","description":"Permanently delete a namespace. The namespace must be empty (no instances), and the default namespace cannot be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/chat/completions":{"post":{"tags":["Search"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/chat/completions"},"summary":"Multi-Instance Chat Completions","description":"Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_search_options":{"type":"object","description":"ai search options","required":true,"properties":{}},"messages":{"type":"array","description":"messages","required":true,"items":{"type":"object","properties":{}}},"model":{"type":"string","description":"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."},"stream":{"type":"boolean","description":"stream","enum":[true,false]}}},"example":{"ai_search_options":{},"messages":[],"model":"","stream":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances":{"get":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"query","description":"Filter by namespace.","required":false,"schema":{"type":"string","example":""}},{"name":"order_by","in":"query","description":"Field to order results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["created_at"]}}},{"name":"order_by_direction","in":"query","description":"Order direction.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Page number (1-indexed).","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page.","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Filter instances whose id contains this string (case-insensitive).","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances"},"summary":"List AI Search instances in a namespace","description":"List all AI Search instances in the account.","security":[{"bearerAuth":[]}]},"post":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances"},"summary":"Create an AI Search instance in a namespace","description":"Create a new AI Search instance with the given configuration.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"type","enum":["r2","web-crawler"]},"ai_gateway_id":{"type":"string","description":"ai gateway id"},"ai_search_model":{"type":"string","description":"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."},"cache":{"type":"boolean","description":"cache","enum":[true,false]},"cache_threshold":{"type":"string","description":"cache threshold","enum":["super_strict_match","close_enough","flexible_friend","anything_goes"]},"cache_ttl":{"type":"string","description":"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)."},"chunk":{"type":"boolean","description":"chunk","enum":[true,false]},"chunk_overlap":{"type":"number","description":"chunk overlap"},"chunk_size":{"type":"number","description":"chunk size"},"custom_metadata":{"type":"array","description":"custom metadata","items":{"type":"object","properties":{}}},"embedding_model":{"type":"string","description":"embedding model"},"fusion_method":{"type":"string","description":"fusion method","enum":["max","rrf"]},"hybrid_search_enabled":{"type":"boolean","description":"Deprecated — use index_method instead.","enum":[true,false]},"id":{"type":"string","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true},"index_method":{"type":"object","description":"Controls which storage backends are used during indexing. Defaults to vector-only.","properties":{}},"indexing_options":{"type":"object","description":"indexing options","properties":{}},"max_num_results":{"type":"number","description":"max num results"},"metadata":{"type":"object","description":"metadata","properties":{}},"public_endpoint_params":{"type":"object","description":"public endpoint params","properties":{}},"reranking":{"type":"boolean","description":"reranking","enum":[true,false]},"reranking_model":{"type":"string","description":"reranking model"},"retrieval_options":{"type":"object","description":"retrieval options","properties":{}},"rewrite_model":{"type":"string","description":"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."},"rewrite_query":{"type":"boolean","description":"rewrite query","enum":[true,false]},"score_threshold":{"type":"number","description":"score threshold"},"source":{"type":"string","description":"source"},"source_params":{"type":"object","description":"source params","properties":{}},"sync_interval":{"type":"string","description":"Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h)."},"token_id":{"type":"string","description":"token id"}}},"example":{"type":"","ai_gateway_id":"","ai_search_model":"","cache":"","cache_threshold":"","cache_ttl":"","chunk":"","chunk_overlap":"","chunk_size":"","custom_metadata":[],"embedding_model":"","fusion_method":"","hybrid_search_enabled":"","id":"","index_method":{},"indexing_options":{},"max_num_results":"","metadata":{},"public_endpoint_params":{},"reranking":"","reranking_model":"","retrieval_options":{},"rewrite_model":"","rewrite_query":"","score_threshold":"","source":"","source_params":{},"sync_interval":"","token_id":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}":{"get":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}"},"summary":"Get an AI Search instance in a namespace","description":"Retrieve the configuration and status of an AI Search instance.","security":[{"bearerAuth":[]}]},"put":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}"},"summary":"Update an AI Search instance by ID in a namespace","description":"Update the configuration of an AI Search instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_gateway_id":{"type":"string","description":"ai gateway id"},"ai_search_model":{"type":"string","description":"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."},"cache":{"type":"boolean","description":"cache","enum":[true,false]},"cache_threshold":{"type":"string","description":"cache threshold","enum":["super_strict_match","close_enough","flexible_friend","anything_goes"]},"cache_ttl":{"type":"string","description":"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)."},"chunk":{"type":"boolean","description":"chunk","enum":[true,false]},"chunk_overlap":{"type":"number","description":"chunk overlap"},"chunk_size":{"type":"number","description":"chunk size"},"custom_metadata":{"type":"array","description":"custom metadata","items":{"type":"object","properties":{}}},"embedding_model":{"type":"string","description":"embedding model"},"fusion_method":{"type":"string","description":"fusion method","enum":["max","rrf"]},"index_method":{"type":"object","description":"Controls which storage backends are used during indexing. Defaults to vector-only.","properties":{}},"indexing_options":{"type":"object","description":"indexing options","properties":{}},"max_num_results":{"type":"number","description":"max num results"},"metadata":{"type":"object","description":"metadata","properties":{}},"paused":{"type":"boolean","description":"paused","enum":[true,false]},"public_endpoint_params":{"type":"object","description":"public endpoint params","properties":{}},"reranking":{"type":"boolean","description":"reranking","enum":[true,false]},"reranking_model":{"type":"string","description":"reranking model"},"retrieval_options":{"type":"object","description":"retrieval options","properties":{}},"rewrite_model":{"type":"string","description":"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."},"rewrite_query":{"type":"boolean","description":"rewrite query","enum":[true,false]},"score_threshold":{"type":"number","description":"score threshold"},"source":{"type":"string","description":"source"},"source_params":{"type":"object","description":"source params","properties":{}},"summarization":{"type":"boolean","description":"summarization","enum":[true,false]},"summarization_model":{"type":"string","description":"summarization model"},"sync_interval":{"type":"string","description":"Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h)."},"system_prompt_ai_search":{"type":"string","description":"system prompt ai search"},"system_prompt_index_summarization":{"type":"string","description":"system prompt index summarization"},"system_prompt_rewrite_query":{"type":"string","description":"system prompt rewrite query"},"token_id":{"type":"string","description":"token id"}}},"example":{"ai_gateway_id":"","ai_search_model":"","cache":"","cache_threshold":"","cache_ttl":"","chunk":"","chunk_overlap":"","chunk_size":"","custom_metadata":[],"embedding_model":"","fusion_method":"","index_method":{},"indexing_options":{},"max_num_results":"","metadata":{},"paused":"","public_endpoint_params":{},"reranking":"","reranking_model":"","retrieval_options":{},"rewrite_model":"","rewrite_query":"","score_threshold":"","source":"","source_params":{},"summarization":"","summarization_model":"","sync_interval":"","system_prompt_ai_search":"","system_prompt_index_summarization":"","system_prompt_rewrite_query":"","token_id":""}}}}},"patch":{"tags":["Namespaces"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"Instance id.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"Current namespace of the instance.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}"},"summary":"Move an instance to a different namespace","description":"Moves an instance from its current namespace to the specified target namespace. Use 'default' with --destination-namespace to move the instance back to the default namespace. Fails with 400 if the target namespace already has an instance with the same id (ids must be unique within a namespace — the same id can exist in different namespaces).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"new_namespace":{"type":"string","description":"Target namespace to move the instance into.","required":true}}},"example":{"new_namespace":""}}}}},"delete":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}"},"summary":"Delete an AI Search instance in a namespace","description":"Permanently delete an AI Search instance and all its indexed data.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions":{"post":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions"},"summary":"Chat Completions (Namespaced Instance)","description":"Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_search_options":{"type":"object","description":"ai search options","properties":{}},"messages":{"type":"array","description":"messages","required":true,"items":{"type":"object","properties":{}}},"model":{"type":"string","description":"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."},"stream":{"type":"boolean","description":"stream","enum":[true,false]}}},"example":{"ai_search_options":{},"messages":[],"model":"","stream":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items":{"get":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"query","description":"Filter items by their unique ID. Returns at most one item.","required":false,"schema":{"type":"string","example":""}},{"name":"key","in":"query","description":"Filter items by their exact key (object key / filename). Keys are unique per source, so combine with `source` to disambiguate across data sources.","required":false,"schema":{"type":"string","example":""}},{"name":"metadata_filter","in":"query","description":"JSON-encoded metadata filter using Vectorize filter syntax. Examples: {\"folder\":\"reports/\"}, {\"timestamp\":{\"$gte\":1700000000000}}, {\"folder\":{\"$in\":[\"docs/\",\"reports/\"]}}","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}},{"name":"sort_by","in":"query","description":"Sort order for items. \"status\" (default) sorts by status priority then last_seen_at. \"modified_at\" sorts by file modification time (most recent first), falling back to created_at.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["status","modified_at"]}}},{"name":"source","in":"query","description":"Filter items by source_id. Use \"builtin\" for uploaded files, or a source identifier like \"web-crawler:https://example.com\".","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["queued","running","completed","error","skipped","outdated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items"},"summary":"Items List (Namespaced Instance)","description":"Lists indexed items in an AI Search instance.","security":[{"bearerAuth":[]}]},"post":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items"},"summary":"Upload Item","description":"Uploads a file to a managed AI Search instance via multipart/form-data. (Multipart upload: file part + string parts; the metadata part is a JSON string of key-value pairs.)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"The file to upload. Filename must not exceed 128 characters.","required":true},"metadata":{"type":"string","description":"JSON string of custom metadata key-value pairs."},"wait_for_completion":{"type":"boolean","description":"Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false.","enum":[true,false]}}},"example":{"file":"(binary)","metadata":"","wait_for_completion":""}}}}},"put":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items"},"summary":"Create or Update Item","description":"Creates or updates an indexed item in an AI Search instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"Item key / filename. Must not exceed 128 characters.","required":true},"next_action":{"type":"string","description":"next action","required":true,"enum":["INDEX"]},"wait_for_completion":{"type":"boolean","description":"Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false.","enum":[true,false]}}},"example":{"key":"","next_action":"","wait_for_completion":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}":{"get":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"path","description":"item id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}"},"summary":"Get Item","description":"Retrieves a specific indexed item from an AI Search instance.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"path","description":"item id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}"},"summary":"Sync Item","description":"Syncs an item to an AI Search instance index.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"next_action":{"type":"string","description":"next action","required":true,"enum":["INDEX"]},"wait_for_completion":{"type":"boolean","description":"Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false.","enum":[true,false]}}},"example":{"next_action":"","wait_for_completion":""}}}}},"delete":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"path","description":"item id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}"},"summary":"Delete Item","description":"Deletes a file from a managed AI Search instance and triggers a reindex.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks":{"get":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"path","description":"item id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"offset","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks"},"summary":"List Item Chunks","description":"Lists chunks for a specific item in an AI Search instance, including their text content.","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download":{"get":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"path","description":"item id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download"},"summary":"Download Item Content","description":"Downloads the raw file content for a specific item from the managed AI Search instance storage.","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs":{"get":{"tags":["Items"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"path","description":"item id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs"},"summary":"Item Logs","description":"Lists processing logs for a specific item in an AI Search instance.","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs":{"get":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs"},"summary":"List Jobs (Namespaced Instance)","description":"Lists indexing jobs for an AI Search instance.","security":[{"bearerAuth":[]}]},"post":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs"},"summary":"Create new job (Namespaced Instance)","description":"Creates a new indexing job for an AI Search instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"}}},"example":{"description":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}":{"get":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}"},"summary":"Get a Job Details (Namespaced Instance)","description":"Retrieves details for a specific AI Search indexing job.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}"},"summary":"Cancel an indexing job (Namespaced Instance)","description":"Cancel an in-progress indexing job for an AI Search instance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"action","required":true,"enum":["cancel"]}}},"example":{"action":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs":{"get":{"tags":["Jobs"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"job id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs"},"summary":"List Job Logs (Namespaced Instance)","description":"Lists log entries for an AI Search indexing job.","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search":{"post":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search"},"summary":"Search (Namespaced Instance)","description":"Executes a semantic search query against an AI Search instance to find relevant indexed content.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_search_options":{"type":"object","description":"ai search options","properties":{}},"messages":{"type":"array","description":"OpenAI-compatible message array. For multimodal queries, set the last user message's `content` to an array of typed parts: `[{type:'text', text:'…'}, {type:'image_url', image_url:{url:'…'}}]`. Image inputs require the RAG's embedding_model to declare 'image' in supported_modalities.","items":{"type":"object","properties":{}}},"query":{"type":"string","description":"A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both."}}},"example":{"ai_search_options":{},"messages":[],"query":""}}}}}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats":{"get":{"tags":["Instances"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats"},"summary":"Get instance statistics (Namespaced Instance)","description":"Retrieve usage and indexing statistics for an AI Search instance.","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/search":{"post":{"tags":["Search"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-search/namespaces/{name}/search"},"summary":"Multi-Instance Search","description":"Performs a semantic search query against multiple AI Search instances in parallel, merging the retrieved results into a single ranked response.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_search_options":{"type":"object","description":"ai search options","required":true,"properties":{}},"messages":{"type":"array","description":"OpenAI-compatible message array. For multimodal queries, set the last user message's `content` to an array of typed parts: `[{type:'text', text:'…'}, {type:'image_url', image_url:{url:'…'}}]`. Image inputs require the RAG's embedding_model to declare 'image' in supported_modalities.","items":{"type":"object","properties":{}}},"query":{"type":"string","description":"A simple text query string. Alternative to 'messages' — provide either this or 'messages', not both."}}},"example":{"ai_search_options":{},"messages":[],"query":""}}}}}},"/client/v4/accounts/{account_id}/autorag/rags/{id}/ai-search":{"post":{"tags":["Search"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"rag id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/ai_search/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/autorag/rags/{id}/ai-search"},"summary":"AI Search","description":"Runs an AI Search query against an AutoRAG.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"filters":{"type":"string","description":"filters"},"max_num_results":{"type":"number","description":"max num results"},"model":{"type":"string","description":"model"},"query":{"type":"string","description":"query","required":true},"ranking_options":{"type":"object","description":"ranking options","properties":{}},"reranking":{"type":"object","description":"reranking","properties":{}},"rewrite_query":{"type":"boolean","description":"rewrite query","enum":[true,false]},"stream":{"type":"boolean","description":"stream","enum":[true,false]},"system_prompt":{"type":"string","description":"system prompt"}}},"example":{"filters":"","max_num_results":"","model":"","query":"","ranking_options":{},"reranking":{},"rewrite_query":"","stream":"","system_prompt":""}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}