--- title: Instances --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [AI Search](https://developers.cloudflare.com/api/python/resources/ai_search) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Instances ##### [List AI Search instances.](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/list) Deprecated aisearch.instances.list(InstanceListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[InstanceListResponse]()] GET/accounts/{account\_id}/ai-search/instances ##### [Create an AI Search instance (Search for Agents requires the default namespace).](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/create) Deprecated aisearch.instances.create(InstanceCreateParams\*\*kwargs) -> [InstanceCreateResponse]() POST/accounts/{account\_id}/ai-search/instances ##### [Get an AI Search instance.](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/read) Deprecated aisearch.instances.read(strid, InstanceReadParams\*\*kwargs) -> [InstanceReadResponse]() GET/accounts/{account\_id}/ai-search/instances/{id} ##### [Update an AI Search instance (Search for Agents metadata requires the default namespace).](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/update) Deprecated aisearch.instances.update(strid, InstanceUpdateParams\*\*kwargs) -> [InstanceUpdateResponse]() PUT/accounts/{account\_id}/ai-search/instances/{id} ##### [Delete an AI Search instance.](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/delete) Deprecated aisearch.instances.delete(strid, InstanceDeleteParams\*\*kwargs) -> [InstanceDeleteResponse]() DELETE/accounts/{account\_id}/ai-search/instances/{id} ##### [Get instance statistics.](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/stats) Deprecated aisearch.instances.stats(strid, InstanceStatsParams\*\*kwargs) -> [InstanceStatsResponse]() GET/accounts/{account\_id}/ai-search/instances/{id}/stats ##### [Search](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/search) Deprecated aisearch.instances.search(strid, InstanceSearchParams\*\*kwargs) -> [InstanceSearchResponse]() POST/accounts/{account\_id}/ai-search/instances/{id}/search ##### [Chat Completions](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/methods/chat_completions) Deprecated aisearch.instances.chat\_completions(strid, InstanceChatCompletionsParams\*\*kwargs) -> [InstanceChatCompletionsResponse]() POST/accounts/{account\_id}/ai-search/instances/{id}/chat/completions ##### ModelsExpand 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
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
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
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
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)>)
class InstanceCreateResponse: … id: str AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. maxLength64 minLength1 Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property ai\_gateway\_id: Optional\[str] Link to this property aisearch\_model: Optional\[str] 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. Link to this property cache: Optional\[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: Optional\[Literal\[600, 1800, 3600, 7 more]] 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). 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\_overlap: Optional\[int] maximum30 minimum0 Link to this property chunk\_size: Optional\[int] minimum64 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 maxLength64 minLength1 Link to this property
Link to this property embedding\_model: Optional\[str] Link to this property enable: Optional\[bool] Link to this property engine\_version: Optional\[float] Link to this property
fusion\_method: Optional\[Literal\["max", "rrf"]] One of the following: "max" Link to this property "rrf" Link to this property
Link to this property Deprecatedhybrid\_search\_enabled: Optional\[bool] Deprecated — use index\_method instead. Defaults to true for new instances; set false to create a vector-only instance. Link to this property
index\_method: Optional\[IndexMethod] Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances. keyword: bool Enable keyword (BM25) storage backend. Link to this property vector: bool Enable vector (embedding) storage backend. Link to this property
Link to this property
indexing\_options: Optional\[IndexingOptions]
keyword\_tokenizer: Optional\[Literal\["porter", "trigram"]] Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. One of the following: "porter" Link to this property "trigram" Link to this property
Link to this property use\_ocr: Optional\[bool] Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. Link to this property
Link to this property last\_activity: Optional\[datetime] formatdate-time Link to this property max\_num\_results: Optional\[int] maximum50 minimum1 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\_by: Optional\[str] Link to this property namespace: Optional\[str] Link to this property paused: Optional\[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] Disable chat completions endpoint for this public endpoint Link to this property
Link to this property custom\_domains: Optional\[List\[str]] Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). Link to this property default\_domain\_enabled: Optional\[bool] When false, the instance is reachable only via a registered custom domain and the default <public\_endpoint\_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public\_endpoint\_params is replaced wholesale on update, so resend default\_domain\_enabled on every update to keep the default host off — omitting it resets to true. Link to this property enabled: Optional\[bool] Link to this property
mcp: Optional\[PublicEndpointParamsMcp] description: Optional\[str] Link to this property disabled: Optional\[bool] Disable MCP endpoint for this public endpoint 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
Link to this property
search\_endpoint: Optional\[PublicEndpointParamsSearchEndpoint] disabled: Optional\[bool] Disable search endpoint for this public endpoint Link to this property
Link to this property
Link to this property reranking: Optional\[bool] Link to this property reranking\_model: Optional\[str] Link to this property
retrieval\_options: Optional\[RetrievalOptions]
boost\_by: Optional\[List\[RetrievalOptionsBoostBy]] Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to ‘asc’ for numeric/datetime fields and ‘exists’ for text/boolean fields. Fields must match ‘timestamp’ or a defined custom\_metadata field. field: str Metadata field name to boost by. Use ‘timestamp’ for document freshness, or any custom\_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not\_exists); text/boolean fields only support exists/not\_exists. maxLength64 minLength1 Link to this property
direction: Optional\[Literal\["asc", "desc", "exists", "not\_exists"]] Boost direction. ‘desc’ = higher values rank higher (e.g. newer timestamps). ‘asc’ = lower values rank higher. ‘exists’ = boost chunks that have the field. ‘not\_exists’ = boost chunks that lack the field. Optional — defaults to ‘asc’ for numeric/datetime fields, ‘exists’ for text/boolean fields. One of the following: "asc" Link to this property "desc" Link to this property "exists" Link to this property "not\_exists" Link to this property
Link to this property
Link to this property
keyword\_match\_mode: Optional\[Literal\["and", "or"]] Controls which documents are candidates for BM25 scoring. ‘and’ restricts candidates to documents containing all query terms; ‘or’ includes any document containing at least one term, ranked by BM25 relevance. When omitted on an update, the existing stored value is preserved; when never set, search falls back to ‘and’. 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] 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. Link to this property rewrite\_query: Optional\[bool] Link to this property score\_threshold: Optional\[float] maximum1 minimum0 Link to this property source: Optional\[str] Link to this property
source\_params: Optional\[SourceParams] exclude\_items: Optional\[List\[str]] List of path patterns to exclude. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /admin/\*\* matches /admin/users and /admin/settings/advanced). Most accounts are limited to 10 rules; contact support to raise it. Link to this property include\_items: Optional\[List\[str]] List of path patterns to include. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /blog/\*\* matches /blog/post and /blog/2024/post). Most accounts are limited to 10 rules; contact support to raise it. 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] Options for parse\_type ‘discover’, where Browser Run discovers URLs by link following and sitemaps. Ignored for ‘sitemap’. depth: Optional\[float] Maximum link-follow depth from the seed URL. maximum100000 minimum1 Link to this property include\_external\_links: Optional\[bool] Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own. Link to this property include\_subdomains: Optional\[bool] Follow links to subdomains of the source host. Link to this property limit: Optional\[float] Maximum number of pages to crawl (1-100000). maximum100000 minimum1 Link to this property max\_age: Optional\[float] Maximum content age in seconds to accept (0–604800). maximum604800 minimum0 Link to this property
source: Optional\[Literal\["all", "sitemaps", "links"]] Where the crawler looks for URLs: ‘sitemaps’ reads sitemap XML only, ‘links’ follows page links only, ‘all’ does both. One of the following: "all" Link to this property "sitemaps" Link to this property "links" Link to this property
Link to this property
Link to this property
parse\_options: Optional\[SourceParamsWebCrawlerParseOptions]
content\_selector: Optional\[List\[SourceParamsWebCrawlerParseOptionsContentSelector]] List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. Omit the field to disable content selection — empty arrays are rejected. path: str Glob pattern to match against the page URL path. Uses standard glob syntax: \* matches within a segment, \*\* crosses directories. maxLength200 minLength1 Link to this property selector: str CSS selector to extract content from pages matching the path pattern. Must not contain disallowed characters (;, \`, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used. maxLength200 minLength1 Link to this property
Link to this property include\_headers: Optional\[Dict\[str, str]] Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF). Link to this property include\_images: Optional\[bool] Link to this property specific\_sitemaps: Optional\[List\[str]] List of specific sitemap URLs to use for crawling. Only valid when parse\_type is ‘sitemap’. Link to this property use\_browser\_rendering: Optional\[bool] Link to this property
Link to this property
parse\_type: Optional\[Literal\["sitemap", "discover"]] How URLs are discovered. ‘sitemap’ reads XML sitemaps; ‘discover’ follows links recursively and requires the source to be a Verified zone on this account. One of the following: "sitemap" Link to this property "discover" Link to this property
Link to this property
Link to this property
Link to this property status: Optional\[str] Link to this property
sync\_interval: Optional\[Literal\[900, 1800, 3600, 5 more]] Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). 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 token\_id: Optional\[str] formatuuid Link to this property
type: Optional\[Literal\["r2", "web-crawler"]] Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. 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_create_response%20%3E%20(schema)>)
class InstanceReadResponse: … id: str AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. maxLength64 minLength1 Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property ai\_gateway\_id: Optional\[str] Link to this property aisearch\_model: Optional\[str] 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. Link to this property cache: Optional\[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: Optional\[Literal\[600, 1800, 3600, 7 more]] 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). 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\_overlap: Optional\[int] maximum30 minimum0 Link to this property chunk\_size: Optional\[int] minimum64 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 maxLength64 minLength1 Link to this property
Link to this property embedding\_model: Optional\[str] Link to this property enable: Optional\[bool] Link to this property engine\_version: Optional\[float] Link to this property
fusion\_method: Optional\[Literal\["max", "rrf"]] One of the following: "max" Link to this property "rrf" Link to this property
Link to this property Deprecatedhybrid\_search\_enabled: Optional\[bool] Deprecated — use index\_method instead. Defaults to true for new instances; set false to create a vector-only instance. Link to this property
index\_method: Optional\[IndexMethod] Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances. keyword: bool Enable keyword (BM25) storage backend. Link to this property vector: bool Enable vector (embedding) storage backend. Link to this property
Link to this property
indexing\_options: Optional\[IndexingOptions]
keyword\_tokenizer: Optional\[Literal\["porter", "trigram"]] Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. One of the following: "porter" Link to this property "trigram" Link to this property
Link to this property use\_ocr: Optional\[bool] Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. Link to this property
Link to this property last\_activity: Optional\[datetime] formatdate-time Link to this property max\_num\_results: Optional\[int] maximum50 minimum1 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\_by: Optional\[str] Link to this property namespace: Optional\[str] Link to this property paused: Optional\[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] Disable chat completions endpoint for this public endpoint Link to this property
Link to this property custom\_domains: Optional\[List\[str]] Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). Link to this property default\_domain\_enabled: Optional\[bool] When false, the instance is reachable only via a registered custom domain and the default <public\_endpoint\_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public\_endpoint\_params is replaced wholesale on update, so resend default\_domain\_enabled on every update to keep the default host off — omitting it resets to true. Link to this property enabled: Optional\[bool] Link to this property
mcp: Optional\[PublicEndpointParamsMcp] description: Optional\[str] Link to this property disabled: Optional\[bool] Disable MCP endpoint for this public endpoint 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
Link to this property
search\_endpoint: Optional\[PublicEndpointParamsSearchEndpoint] disabled: Optional\[bool] Disable search endpoint for this public endpoint Link to this property
Link to this property
Link to this property reranking: Optional\[bool] Link to this property reranking\_model: Optional\[str] Link to this property
retrieval\_options: Optional\[RetrievalOptions]
boost\_by: Optional\[List\[RetrievalOptionsBoostBy]] Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to ‘asc’ for numeric/datetime fields and ‘exists’ for text/boolean fields. Fields must match ‘timestamp’ or a defined custom\_metadata field. field: str Metadata field name to boost by. Use ‘timestamp’ for document freshness, or any custom\_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not\_exists); text/boolean fields only support exists/not\_exists. maxLength64 minLength1 Link to this property
direction: Optional\[Literal\["asc", "desc", "exists", "not\_exists"]] Boost direction. ‘desc’ = higher values rank higher (e.g. newer timestamps). ‘asc’ = lower values rank higher. ‘exists’ = boost chunks that have the field. ‘not\_exists’ = boost chunks that lack the field. Optional — defaults to ‘asc’ for numeric/datetime fields, ‘exists’ for text/boolean fields. One of the following: "asc" Link to this property "desc" Link to this property "exists" Link to this property "not\_exists" Link to this property
Link to this property
Link to this property
keyword\_match\_mode: Optional\[Literal\["and", "or"]] Controls which documents are candidates for BM25 scoring. ‘and’ restricts candidates to documents containing all query terms; ‘or’ includes any document containing at least one term, ranked by BM25 relevance. When omitted on an update, the existing stored value is preserved; when never set, search falls back to ‘and’. 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] 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. Link to this property rewrite\_query: Optional\[bool] Link to this property score\_threshold: Optional\[float] maximum1 minimum0 Link to this property source: Optional\[str] Link to this property
source\_params: Optional\[SourceParams] exclude\_items: Optional\[List\[str]] List of path patterns to exclude. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /admin/\*\* matches /admin/users and /admin/settings/advanced). Most accounts are limited to 10 rules; contact support to raise it. Link to this property include\_items: Optional\[List\[str]] List of path patterns to include. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /blog/\*\* matches /blog/post and /blog/2024/post). Most accounts are limited to 10 rules; contact support to raise it. 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] Options for parse\_type ‘discover’, where Browser Run discovers URLs by link following and sitemaps. Ignored for ‘sitemap’. depth: Optional\[float] Maximum link-follow depth from the seed URL. maximum100000 minimum1 Link to this property include\_external\_links: Optional\[bool] Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own. Link to this property include\_subdomains: Optional\[bool] Follow links to subdomains of the source host. Link to this property limit: Optional\[float] Maximum number of pages to crawl (1-100000). maximum100000 minimum1 Link to this property max\_age: Optional\[float] Maximum content age in seconds to accept (0–604800). maximum604800 minimum0 Link to this property
source: Optional\[Literal\["all", "sitemaps", "links"]] Where the crawler looks for URLs: ‘sitemaps’ reads sitemap XML only, ‘links’ follows page links only, ‘all’ does both. One of the following: "all" Link to this property "sitemaps" Link to this property "links" Link to this property
Link to this property
Link to this property
parse\_options: Optional\[SourceParamsWebCrawlerParseOptions]
content\_selector: Optional\[List\[SourceParamsWebCrawlerParseOptionsContentSelector]] List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. Omit the field to disable content selection — empty arrays are rejected. path: str Glob pattern to match against the page URL path. Uses standard glob syntax: \* matches within a segment, \*\* crosses directories. maxLength200 minLength1 Link to this property selector: str CSS selector to extract content from pages matching the path pattern. Must not contain disallowed characters (;, \`, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used. maxLength200 minLength1 Link to this property
Link to this property include\_headers: Optional\[Dict\[str, str]] Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF). Link to this property include\_images: Optional\[bool] Link to this property specific\_sitemaps: Optional\[List\[str]] List of specific sitemap URLs to use for crawling. Only valid when parse\_type is ‘sitemap’. Link to this property use\_browser\_rendering: Optional\[bool] Link to this property
Link to this property
parse\_type: Optional\[Literal\["sitemap", "discover"]] How URLs are discovered. ‘sitemap’ reads XML sitemaps; ‘discover’ follows links recursively and requires the source to be a Verified zone on this account. One of the following: "sitemap" Link to this property "discover" Link to this property
Link to this property
Link to this property
Link to this property status: Optional\[str] Link to this property
sync\_interval: Optional\[Literal\[900, 1800, 3600, 5 more]] Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). 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 token\_id: Optional\[str] formatuuid Link to this property
type: Optional\[Literal\["r2", "web-crawler"]] Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. 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_read_response%20%3E%20(schema)>)
class InstanceUpdateResponse: … id: str AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. maxLength64 minLength1 Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property ai\_gateway\_id: Optional\[str] Link to this property aisearch\_model: Optional\[str] 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. Link to this property cache: Optional\[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: Optional\[Literal\[600, 1800, 3600, 7 more]] 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). 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\_overlap: Optional\[int] maximum30 minimum0 Link to this property chunk\_size: Optional\[int] minimum64 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 maxLength64 minLength1 Link to this property
Link to this property embedding\_model: Optional\[str] Link to this property enable: Optional\[bool] Link to this property engine\_version: Optional\[float] Link to this property
fusion\_method: Optional\[Literal\["max", "rrf"]] One of the following: "max" Link to this property "rrf" Link to this property
Link to this property Deprecatedhybrid\_search\_enabled: Optional\[bool] Deprecated — use index\_method instead. Defaults to true for new instances; set false to create a vector-only instance. Link to this property
index\_method: Optional\[IndexMethod] Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances. keyword: bool Enable keyword (BM25) storage backend. Link to this property vector: bool Enable vector (embedding) storage backend. Link to this property
Link to this property
indexing\_options: Optional\[IndexingOptions]
keyword\_tokenizer: Optional\[Literal\["porter", "trigram"]] Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. One of the following: "porter" Link to this property "trigram" Link to this property
Link to this property use\_ocr: Optional\[bool] Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. Link to this property
Link to this property last\_activity: Optional\[datetime] formatdate-time Link to this property max\_num\_results: Optional\[int] maximum50 minimum1 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\_by: Optional\[str] Link to this property namespace: Optional\[str] Link to this property paused: Optional\[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] Disable chat completions endpoint for this public endpoint Link to this property
Link to this property custom\_domains: Optional\[List\[str]] Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). Link to this property default\_domain\_enabled: Optional\[bool] When false, the instance is reachable only via a registered custom domain and the default <public\_endpoint\_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public\_endpoint\_params is replaced wholesale on update, so resend default\_domain\_enabled on every update to keep the default host off — omitting it resets to true. Link to this property enabled: Optional\[bool] Link to this property
mcp: Optional\[PublicEndpointParamsMcp] description: Optional\[str] Link to this property disabled: Optional\[bool] Disable MCP endpoint for this public endpoint 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
Link to this property
search\_endpoint: Optional\[PublicEndpointParamsSearchEndpoint] disabled: Optional\[bool] Disable search endpoint for this public endpoint Link to this property
Link to this property
Link to this property reranking: Optional\[bool] Link to this property reranking\_model: Optional\[str] Link to this property
retrieval\_options: Optional\[RetrievalOptions]
boost\_by: Optional\[List\[RetrievalOptionsBoostBy]] Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to ‘asc’ for numeric/datetime fields and ‘exists’ for text/boolean fields. Fields must match ‘timestamp’ or a defined custom\_metadata field. field: str Metadata field name to boost by. Use ‘timestamp’ for document freshness, or any custom\_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not\_exists); text/boolean fields only support exists/not\_exists. maxLength64 minLength1 Link to this property
direction: Optional\[Literal\["asc", "desc", "exists", "not\_exists"]] Boost direction. ‘desc’ = higher values rank higher (e.g. newer timestamps). ‘asc’ = lower values rank higher. ‘exists’ = boost chunks that have the field. ‘not\_exists’ = boost chunks that lack the field. Optional — defaults to ‘asc’ for numeric/datetime fields, ‘exists’ for text/boolean fields. One of the following: "asc" Link to this property "desc" Link to this property "exists" Link to this property "not\_exists" Link to this property
Link to this property
Link to this property
keyword\_match\_mode: Optional\[Literal\["and", "or"]] Controls which documents are candidates for BM25 scoring. ‘and’ restricts candidates to documents containing all query terms; ‘or’ includes any document containing at least one term, ranked by BM25 relevance. When omitted on an update, the existing stored value is preserved; when never set, search falls back to ‘and’. 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] 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. Link to this property rewrite\_query: Optional\[bool] Link to this property score\_threshold: Optional\[float] maximum1 minimum0 Link to this property source: Optional\[str] Link to this property
source\_params: Optional\[SourceParams] exclude\_items: Optional\[List\[str]] List of path patterns to exclude. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /admin/\*\* matches /admin/users and /admin/settings/advanced). Most accounts are limited to 10 rules; contact support to raise it. Link to this property include\_items: Optional\[List\[str]] List of path patterns to include. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /blog/\*\* matches /blog/post and /blog/2024/post). Most accounts are limited to 10 rules; contact support to raise it. 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] Options for parse\_type ‘discover’, where Browser Run discovers URLs by link following and sitemaps. Ignored for ‘sitemap’. depth: Optional\[float] Maximum link-follow depth from the seed URL. maximum100000 minimum1 Link to this property include\_external\_links: Optional\[bool] Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own. Link to this property include\_subdomains: Optional\[bool] Follow links to subdomains of the source host. Link to this property limit: Optional\[float] Maximum number of pages to crawl (1-100000). maximum100000 minimum1 Link to this property max\_age: Optional\[float] Maximum content age in seconds to accept (0–604800). maximum604800 minimum0 Link to this property
source: Optional\[Literal\["all", "sitemaps", "links"]] Where the crawler looks for URLs: ‘sitemaps’ reads sitemap XML only, ‘links’ follows page links only, ‘all’ does both. One of the following: "all" Link to this property "sitemaps" Link to this property "links" Link to this property
Link to this property
Link to this property
parse\_options: Optional\[SourceParamsWebCrawlerParseOptions]
content\_selector: Optional\[List\[SourceParamsWebCrawlerParseOptionsContentSelector]] List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. Omit the field to disable content selection — empty arrays are rejected. path: str Glob pattern to match against the page URL path. Uses standard glob syntax: \* matches within a segment, \*\* crosses directories. maxLength200 minLength1 Link to this property selector: str CSS selector to extract content from pages matching the path pattern. Must not contain disallowed characters (;, \`, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used. maxLength200 minLength1 Link to this property
Link to this property include\_headers: Optional\[Dict\[str, str]] Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF). Link to this property include\_images: Optional\[bool] Link to this property specific\_sitemaps: Optional\[List\[str]] List of specific sitemap URLs to use for crawling. Only valid when parse\_type is ‘sitemap’. Link to this property use\_browser\_rendering: Optional\[bool] Link to this property
Link to this property
parse\_type: Optional\[Literal\["sitemap", "discover"]] How URLs are discovered. ‘sitemap’ reads XML sitemaps; ‘discover’ follows links recursively and requires the source to be a Verified zone on this account. One of the following: "sitemap" Link to this property "discover" Link to this property
Link to this property
Link to this property
Link to this property status: Optional\[str] Link to this property
sync\_interval: Optional\[Literal\[900, 1800, 3600, 5 more]] Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). 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 token\_id: Optional\[str] formatuuid Link to this property
type: Optional\[Literal\["r2", "web-crawler"]] Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. 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_update_response%20%3E%20(schema)>)
class InstanceDeleteResponse: … id: str AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. maxLength64 minLength1 Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property ai\_gateway\_id: Optional\[str] Link to this property aisearch\_model: Optional\[str] 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. Link to this property cache: Optional\[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: Optional\[Literal\[600, 1800, 3600, 7 more]] 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). 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\_overlap: Optional\[int] maximum30 minimum0 Link to this property chunk\_size: Optional\[int] minimum64 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 maxLength64 minLength1 Link to this property
Link to this property embedding\_model: Optional\[str] Link to this property enable: Optional\[bool] Link to this property engine\_version: Optional\[float] Link to this property
fusion\_method: Optional\[Literal\["max", "rrf"]] One of the following: "max" Link to this property "rrf" Link to this property
Link to this property Deprecatedhybrid\_search\_enabled: Optional\[bool] Deprecated — use index\_method instead. Defaults to true for new instances; set false to create a vector-only instance. Link to this property
index\_method: Optional\[IndexMethod] Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances. keyword: bool Enable keyword (BM25) storage backend. Link to this property vector: bool Enable vector (embedding) storage backend. Link to this property
Link to this property
indexing\_options: Optional\[IndexingOptions]
keyword\_tokenizer: Optional\[Literal\["porter", "trigram"]] Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. One of the following: "porter" Link to this property "trigram" Link to this property
Link to this property use\_ocr: Optional\[bool] Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false. Link to this property
Link to this property last\_activity: Optional\[datetime] formatdate-time Link to this property max\_num\_results: Optional\[int] maximum50 minimum1 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\_by: Optional\[str] Link to this property namespace: Optional\[str] Link to this property paused: Optional\[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] Disable chat completions endpoint for this public endpoint Link to this property
Link to this property custom\_domains: Optional\[List\[str]] Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged). Link to this property default\_domain\_enabled: Optional\[bool] When false, the instance is reachable only via a registered custom domain and the default <public\_endpoint\_id>.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. public\_endpoint\_params is replaced wholesale on update, so resend default\_domain\_enabled on every update to keep the default host off — omitting it resets to true. Link to this property enabled: Optional\[bool] Link to this property
mcp: Optional\[PublicEndpointParamsMcp] description: Optional\[str] Link to this property disabled: Optional\[bool] Disable MCP endpoint for this public endpoint 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
Link to this property
search\_endpoint: Optional\[PublicEndpointParamsSearchEndpoint] disabled: Optional\[bool] Disable search endpoint for this public endpoint Link to this property
Link to this property
Link to this property reranking: Optional\[bool] Link to this property reranking\_model: Optional\[str] Link to this property
retrieval\_options: Optional\[RetrievalOptions]
boost\_by: Optional\[List\[RetrievalOptionsBoostBy]] Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to ‘asc’ for numeric/datetime fields and ‘exists’ for text/boolean fields. Fields must match ‘timestamp’ or a defined custom\_metadata field. field: str Metadata field name to boost by. Use ‘timestamp’ for document freshness, or any custom\_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not\_exists); text/boolean fields only support exists/not\_exists. maxLength64 minLength1 Link to this property
direction: Optional\[Literal\["asc", "desc", "exists", "not\_exists"]] Boost direction. ‘desc’ = higher values rank higher (e.g. newer timestamps). ‘asc’ = lower values rank higher. ‘exists’ = boost chunks that have the field. ‘not\_exists’ = boost chunks that lack the field. Optional — defaults to ‘asc’ for numeric/datetime fields, ‘exists’ for text/boolean fields. One of the following: "asc" Link to this property "desc" Link to this property "exists" Link to this property "not\_exists" Link to this property
Link to this property
Link to this property
keyword\_match\_mode: Optional\[Literal\["and", "or"]] Controls which documents are candidates for BM25 scoring. ‘and’ restricts candidates to documents containing all query terms; ‘or’ includes any document containing at least one term, ranked by BM25 relevance. When omitted on an update, the existing stored value is preserved; when never set, search falls back to ‘and’. 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] 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. Link to this property rewrite\_query: Optional\[bool] Link to this property score\_threshold: Optional\[float] maximum1 minimum0 Link to this property source: Optional\[str] Link to this property
source\_params: Optional\[SourceParams] exclude\_items: Optional\[List\[str]] List of path patterns to exclude. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /admin/\*\* matches /admin/users and /admin/settings/advanced). Most accounts are limited to 10 rules; contact support to raise it. Link to this property include\_items: Optional\[List\[str]] List of path patterns to include. Uses micromatch glob syntax: \* matches within a path segment, \*\* matches across path segments (e.g., /blog/\*\* matches /blog/post and /blog/2024/post). Most accounts are limited to 10 rules; contact support to raise it. 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] Options for parse\_type ‘discover’, where Browser Run discovers URLs by link following and sitemaps. Ignored for ‘sitemap’. depth: Optional\[float] Maximum link-follow depth from the seed URL. maximum100000 minimum1 Link to this property include\_external\_links: Optional\[bool] Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own. Link to this property include\_subdomains: Optional\[bool] Follow links to subdomains of the source host. Link to this property limit: Optional\[float] Maximum number of pages to crawl (1-100000). maximum100000 minimum1 Link to this property max\_age: Optional\[float] Maximum content age in seconds to accept (0–604800). maximum604800 minimum0 Link to this property
source: Optional\[Literal\["all", "sitemaps", "links"]] Where the crawler looks for URLs: ‘sitemaps’ reads sitemap XML only, ‘links’ follows page links only, ‘all’ does both. One of the following: "all" Link to this property "sitemaps" Link to this property "links" Link to this property
Link to this property
Link to this property
parse\_options: Optional\[SourceParamsWebCrawlerParseOptions]
content\_selector: Optional\[List\[SourceParamsWebCrawlerParseOptionsContentSelector]] List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. Omit the field to disable content selection — empty arrays are rejected. path: str Glob pattern to match against the page URL path. Uses standard glob syntax: \* matches within a segment, \*\* crosses directories. maxLength200 minLength1 Link to this property selector: str CSS selector to extract content from pages matching the path pattern. Must not contain disallowed characters (;, \`, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used. maxLength200 minLength1 Link to this property
Link to this property include\_headers: Optional\[Dict\[str, str]] Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF). Link to this property include\_images: Optional\[bool] Link to this property specific\_sitemaps: Optional\[List\[str]] List of specific sitemap URLs to use for crawling. Only valid when parse\_type is ‘sitemap’. Link to this property use\_browser\_rendering: Optional\[bool] Link to this property
Link to this property
parse\_type: Optional\[Literal\["sitemap", "discover"]] How URLs are discovered. ‘sitemap’ reads XML sitemaps; ‘discover’ follows links recursively and requires the source to be a Verified zone on this account. One of the following: "sitemap" Link to this property "discover" Link to this property
Link to this property
Link to this property
Link to this property status: Optional\[str] Link to this property
sync\_interval: Optional\[Literal\[900, 1800, 3600, 5 more]] Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). 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 token\_id: Optional\[str] formatuuid Link to this property
type: Optional\[Literal\["r2", "web-crawler"]] Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. 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_delete_response%20%3E%20(schema)>)
class InstanceStatsResponse: … completed: Optional\[int] Link to this property degraded: Optional\[bool] True when status counts are unavailable (e.g. legacy stats query exceeded D1 statement-size limit). Counts are omitted in this case. Link to this property
engine: Optional\[Engine] Engine-specific metadata. Present only for managed (v3) instances.
r2: Optional\[EngineR2] R2 bucket storage usage in bytes. metadata\_size\_bytes: int Link to this property object\_count: int Link to this property payload\_size\_bytes: int Link to this property
Link to this property
vectorize: Optional\[EngineVectorize] Vectorize index metadata (dimensions, vector count). dimensions: int Link to this property vectors\_count: int Link to this property
Link to this property
Link to this property error: Optional\[int] Link to this property file\_embed\_errors: Optional\[Dict\[str, object]] Link to this property index\_source\_errors: Optional\[Dict\[str, object]] Link to this property last\_activity: Optional\[datetime] formatdate-time Link to this property outdated: Optional\[int] Link to this property queued: Optional\[int] Link to this property running: Optional\[int] Link to this property skipped: Optional\[int] Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)>)
class InstanceSearchResponse: …
chunks: List\[Chunk] id: str Link to this property score: float maximum1 minimum0 Link to this property text: str Link to this property type: str Link to this property
item: Optional\[ChunkItem] key: str Link to this property metadata: Optional\[Dict\[str, object]] Link to this property timestamp: Optional\[float] Link to this property
Link to this property
scoring\_details: Optional\[ChunkScoringDetails]
fusion\_method: Optional\[Literal\["rrf", "max"]] One of the following: "rrf" Link to this property "max" Link to this property
Link to this property keyword\_rank: Optional\[float] Link to this property keyword\_score: Optional\[float] minimum0 Link to this property reranking\_score: Optional\[float] maximum1 minimum0 Link to this property vector\_rank: Optional\[float] Link to this property vector\_score: Optional\[float] maximum1 minimum0 Link to this property
Link to this property
Link to this property
query\_kind: Literal\["text", "image", "multimodal"] One of the following: "text" Link to this property "image" Link to this property "multimodal" Link to this property
Link to this property search\_query: Optional\[str] Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20instance_search_response%20%3E%20(schema)>)
class InstanceChatCompletionsResponse: …
choices: List\[Choice]
message: ChoiceMessage
content: Union\[str, List\[ChoiceMessageContentUnionMember1], Optional\[str]] One of the following: str Link to this property
List\[ChoiceMessageContentUnionMember1] One of the following:
class ChoiceMessageContentUnionMember1UnionMember0: … text: str minLength1 Link to this property type: Literal\["text"] Link to this property
Link to this property
class ChoiceMessageContentUnionMember1UnionMember1: …
image\_url: ChoiceMessageContentUnionMember1UnionMember1ImageURL url: str maxLength20971520 minLength1 Link to this property
Link to this property type: Literal\["image\_url"] Link to this property
Link to this property
class ChoiceMessageContentUnionMember1UnionMember2: …
file: ChoiceMessageContentUnionMember1UnionMember2File filename: str maxLength255 minLength1 Link to this property file\_data: Optional\[str] maxLength13981144 minLength1 Link to this property file\_id: Optional\[str] Link to this property
Link to this property type: Literal\["file"] Link to this property
Link to this property
Link to this property Optional\[str] Link to this property
Link to this property
role: Literal\["system", "developer", "user", 2 more] One of the following: "system" Link to this property "developer" Link to this property "user" Link to this property "assistant" Link to this property "tool" Link to this property
Link to this property
Link to this property index: Optional\[int] Link to this property
Link to this property
chunks: List\[Chunk] id: str Link to this property score: float maximum1 minimum0 Link to this property text: str Link to this property type: str Link to this property
item: Optional\[ChunkItem] key: str Link to this property metadata: Optional\[Dict\[str, object]] Link to this property timestamp: Optional\[float] Link to this property
Link to this property
scoring\_details: Optional\[ChunkScoringDetails]
fusion\_method: Optional\[Literal\["rrf", "max"]] One of the following: "rrf" Link to this property "max" Link to this property
Link to this property keyword\_rank: Optional\[float] Link to this property keyword\_score: Optional\[float] minimum0 Link to this property reranking\_score: Optional\[float] maximum1 minimum0 Link to this property vector\_rank: Optional\[float] Link to this property vector\_score: Optional\[float] maximum1 minimum0 Link to this property
Link to this property
Link to this property id: Optional\[str] Link to this property model: Optional\[str] Link to this property object: Optional\[str] Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20instance_chat_completions_response%20%3E%20(schema)>) #### InstancesJobs ##### [List Jobs](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/subresources/jobs/methods/list) Deprecated aisearch.instances.jobs.list(strid, JobListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[JobListResponse]()] GET/accounts/{account\_id}/ai-search/instances/{id}/jobs ##### [Create new job](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/subresources/jobs/methods/create) Deprecated aisearch.instances.jobs.create(strid, JobCreateParams\*\*kwargs) -> [JobCreateResponse]() POST/accounts/{account\_id}/ai-search/instances/{id}/jobs ##### [Get a Job Details](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/subresources/jobs/methods/get) Deprecated aisearch.instances.jobs.get(strjob\_id, JobGetParams\*\*kwargs) -> [JobGetResponse]() GET/accounts/{account\_id}/ai-search/instances/{id}/jobs/{job\_id} ##### [List Job Logs](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances/subresources/jobs/methods/logs) Deprecated aisearch.instances.jobs.logs(strjob\_id, JobLogsParams\*\*kwargs) -> [JobLogsResponse]() GET/accounts/{account\_id}/ai-search/instances/{id}/jobs/{job\_id}/logs ##### ModelsExpand Collapse
class JobListResponse: … id: str Link to this property
source: Literal\["user", "schedule"] One of the following: "user" Link to this property "schedule" Link to this property
Link to this property description: Optional\[str] Link to this property end\_reason: Optional\[str] Link to this property ended\_at: Optional\[str] Link to this property last\_seen\_at: Optional\[str] Link to this property started\_at: Optional\[str] Link to this property
[Link to this property](<#(resource)%20ai_search.instances.jobs%20%3E%20(model)%20job_list_response%20%3E%20(schema)>)
class JobCreateResponse: … id: str Link to this property
source: Literal\["user", "schedule"] One of the following: "user" Link to this property "schedule" Link to this property
Link to this property description: Optional\[str] Link to this property end\_reason: Optional\[str] Link to this property ended\_at: Optional\[str] Link to this property last\_seen\_at: Optional\[str] Link to this property started\_at: Optional\[str] Link to this property
[Link to this property](<#(resource)%20ai_search.instances.jobs%20%3E%20(model)%20job_create_response%20%3E%20(schema)>)
class JobGetResponse: … id: str Link to this property
source: Literal\["user", "schedule"] One of the following: "user" Link to this property "schedule" Link to this property
Link to this property description: Optional\[str] Link to this property end\_reason: Optional\[str] Link to this property ended\_at: Optional\[str] Link to this property last\_seen\_at: Optional\[str] Link to this property started\_at: Optional\[str] Link to this property
[Link to this property](<#(resource)%20ai_search.instances.jobs%20%3E%20(model)%20job_get_response%20%3E%20(schema)>)
List\[JobLogsResponseItem] id: int Link to this property created\_at: float Link to this property message: str Link to this property message\_type: int Link to this property
[Link to this property](<#(resource)%20ai_search.instances.jobs%20%3E%20(model)%20job_logs_response%20%3E%20(schema)>)