POST /accounts/{account_id}/ai-search/instances

Default value: "application/json"

Default value: false

Default value: true

AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

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.

Valid values:

• "trigram"
• "porter"

Default value: "porter"

Valid values:

• "max"
• "rrf"

Default value: "rrf"

Default value: true

Default value: 10

Valid values:

• "r2"
• "web-crawler"
• null

Default value: { "parse_type": "sitemap" }

How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account.

Valid values:

• "discover"
• "sitemap"

Default value: "sitemap"

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).

Default value: true

Default value: false

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.

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.

Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.

List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'.

Options for parse_type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.

Follow links to subdomains of the source host.

Default value: false

Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both.

Valid values:

• "links"
• "sitemaps"
• "all"

Default value: "all"

Maximum number of pages to crawl (1-100000).

Default value: 100000

Maximum link-follow depth from the seed URL.

Default value: 5

Maximum content age in seconds to accept (0–604800).

Default value: 86400

Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.

Default value: false

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.

Default value: "default"

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.

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.

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.

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.

Valid values:

• "exists"
• "not_exists"
• "desc"
• "asc"

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'.

Valid values:

• "and"
• "or"

Valid values:

• "text"
• "boolean"
• "datetime"
• "number"

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).

Default value: 172800

Default value: 10

Default value: false

Default value: 0.4

Deprecated — use index_method instead.

Default value: false

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).

Disable chat completions endpoint for this public endpoint

Default value: false

Disable search endpoint for this public endpoint

Default value: false

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.

Default value: true

Default value: false

Default value: "Finds exactly what you're looking for"

Disable MCP endpoint for this public endpoint

Default value: false

Valid values:

• "fixed"
• "sliding"

Valid values:

• "flexible_friend"
• "super_strict_match"
• "anything_goes"
• "close_enough"

Default value: "close_enough"

Controls which storage backends are used during indexing. Defaults to vector-only.

Default value: { "vector": true, "keyword": false }

Enable vector (embedding) storage backend.

Enable keyword (BM25) storage backend.

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

Default value: 21600