Create an AI Search instance (Search for Agents requires the default namespace).

Deprecated

client.AISearch.Instances.New(ctx, params) (*InstanceNewResponse, error)

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

Create a new AI Search instance with the given configuration. If type is omitted or null, a non-blank HTTP(S) source infers web-crawler and an existing R2 bucket source infers r2. A missing or blank source without a type creates a managed upload-only instance. Search for Agents instances require the default namespace.

Deprecated: use /accounts/{account_id}/ai-search/namespaces/{name}/instances (and descendant paths) instead.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params InstanceNewParams

AccountID param.Field[string]

Path param

ID param.Field[string]

Body param: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

maxLength64

minLength1

AIGatewayID param.Field[string]Optional

Body param

AISearchModel param.Field[string]Optional

Body param: 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 param.Field[bool]Optional

Body param

CacheThreshold param.Field[InstanceNewParamsCacheThreshold]Optional

Body param

const InstanceNewParamsCacheThresholdSuperStrictMatch InstanceNewParamsCacheThreshold = "super_strict_match"

const InstanceNewParamsCacheThresholdCloseEnough InstanceNewParamsCacheThreshold = "close_enough"

const InstanceNewParamsCacheThresholdFlexibleFriend InstanceNewParamsCacheThreshold = "flexible_friend"

const InstanceNewParamsCacheThresholdAnythingGoes InstanceNewParamsCacheThreshold = "anything_goes"

CacheTTL param.Field[InstanceNewParamsCacheTTL]Optional

Body param: 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).

const InstanceNewParamsCacheTTL600 InstanceNewParamsCacheTTL = 600

const InstanceNewParamsCacheTTL1800 InstanceNewParamsCacheTTL = 1800

const InstanceNewParamsCacheTTL3600 InstanceNewParamsCacheTTL = 3600

const InstanceNewParamsCacheTTL7200 InstanceNewParamsCacheTTL = 7200

const InstanceNewParamsCacheTTL21600 InstanceNewParamsCacheTTL = 21600

const InstanceNewParamsCacheTTL43200 InstanceNewParamsCacheTTL = 43200

const InstanceNewParamsCacheTTL86400 InstanceNewParamsCacheTTL = 86400

const InstanceNewParamsCacheTTL172800 InstanceNewParamsCacheTTL = 172800

const InstanceNewParamsCacheTTL259200 InstanceNewParamsCacheTTL = 259200

const InstanceNewParamsCacheTTL518400 InstanceNewParamsCacheTTL = 518400

Chunk param.Field[bool]Optional

Body param

ChunkOverlap param.Field[int64]Optional

Body param

maximum30

minimum0

ChunkSize param.Field[int64]Optional

Body param

minimum64

CustomMetadata param.Field[[]InstanceNewParamsCustomMetadata]Optional

Body param

DataType InstanceNewParamsCustomMetadataDataType

One of the following:

const InstanceNewParamsCustomMetadataDataTypeText InstanceNewParamsCustomMetadataDataType = "text"

const InstanceNewParamsCustomMetadataDataTypeNumber InstanceNewParamsCustomMetadataDataType = "number"

const InstanceNewParamsCustomMetadataDataTypeBoolean InstanceNewParamsCustomMetadataDataType = "boolean"

const InstanceNewParamsCustomMetadataDataTypeDatetime InstanceNewParamsCustomMetadataDataType = "datetime"

FieldName string

maxLength64

minLength1

EmbeddingModel param.Field[string]Optional

Body param

FusionMethod param.Field[InstanceNewParamsFusionMethod]Optional

Body param

const InstanceNewParamsFusionMethodMax InstanceNewParamsFusionMethod = "max"

const InstanceNewParamsFusionMethodRrf InstanceNewParamsFusionMethod = "rrf"

DeprecatedHybridSearchEnabled param.Field[bool]Optional

Body param: Deprecated — use index_method instead. Defaults to true for new instances; set false to create a vector-only instance.

IndexMethod param.Field[InstanceNewParamsIndexMethod]Optional

Body param: Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.

Keyword bool

Enable keyword (BM25) storage backend.

Vector bool

Enable vector (embedding) storage backend.

IndexingOptions param.Field[InstanceNewParamsIndexingOptions]Optional

Body param

KeywordTokenizer InstanceNewParamsIndexingOptionsKeywordTokenizerOptional

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:

const InstanceNewParamsIndexingOptionsKeywordTokenizerPorter InstanceNewParamsIndexingOptionsKeywordTokenizer = "porter"

const InstanceNewParamsIndexingOptionsKeywordTokenizerTrigram InstanceNewParamsIndexingOptionsKeywordTokenizer = "trigram"

UseOCR boolOptional

Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.

MaxNumResults param.Field[int64]Optional

Body param

maximum50

minimum1

Metadata param.Field[InstanceNewParamsMetadata]Optional

Body param

CreatedFromAISearchWizard boolOptional

WorkerDomain stringOptional

PublicEndpointParams param.Field[InstanceNewParamsPublicEndpointParams]Optional

Body param

AuthorizedHosts []stringOptional

ChatCompletionsEndpoint InstanceNewParamsPublicEndpointParamsChatCompletionsEndpointOptional

Disabled boolOptional

Disable chat completions endpoint for this public endpoint

CustomDomains []stringOptional

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

DefaultDomainEnabled boolOptional

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.

Enabled boolOptional

Mcp InstanceNewParamsPublicEndpointParamsMcpOptional

Description stringOptional

Disabled boolOptional

Disable MCP endpoint for this public endpoint

RateLimit InstanceNewParamsPublicEndpointParamsRateLimitOptional

PeriodMs int64Optional

maximum3600000

minimum60000

Requests int64Optional

minimum1

Technique InstanceNewParamsPublicEndpointParamsRateLimitTechniqueOptional

One of the following:

const InstanceNewParamsPublicEndpointParamsRateLimitTechniqueFixed InstanceNewParamsPublicEndpointParamsRateLimitTechnique = "fixed"

const InstanceNewParamsPublicEndpointParamsRateLimitTechniqueSliding InstanceNewParamsPublicEndpointParamsRateLimitTechnique = "sliding"

SearchEndpoint InstanceNewParamsPublicEndpointParamsSearchEndpointOptional

Disabled boolOptional

Disable search endpoint for this public endpoint

Reranking param.Field[bool]Optional

Body param

RerankingModel param.Field[string]Optional

Body param

RetrievalOptions param.Field[InstanceNewParamsRetrievalOptions]Optional

Body param

BoostBy []InstanceNewParamsRetrievalOptionsBoostByOptional

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 string

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

Direction InstanceNewParamsRetrievalOptionsBoostByDirectionOptional

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:

const InstanceNewParamsRetrievalOptionsBoostByDirectionAsc InstanceNewParamsRetrievalOptionsBoostByDirection = "asc"

const InstanceNewParamsRetrievalOptionsBoostByDirectionDesc InstanceNewParamsRetrievalOptionsBoostByDirection = "desc"

const InstanceNewParamsRetrievalOptionsBoostByDirectionExists InstanceNewParamsRetrievalOptionsBoostByDirection = "exists"

const InstanceNewParamsRetrievalOptionsBoostByDirectionNotExists InstanceNewParamsRetrievalOptionsBoostByDirection = "not_exists"

KeywordMatchMode InstanceNewParamsRetrievalOptionsKeywordMatchModeOptional

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:

const InstanceNewParamsRetrievalOptionsKeywordMatchModeAnd InstanceNewParamsRetrievalOptionsKeywordMatchMode = "and"

const InstanceNewParamsRetrievalOptionsKeywordMatchModeOr InstanceNewParamsRetrievalOptionsKeywordMatchMode = "or"

RewriteModel param.Field[string]Optional

Body param: 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.

RewriteQuery param.Field[bool]Optional

Body param

ScoreThreshold param.Field[float64]Optional

Body param

maximum1

minimum0

Source param.Field[string]Optional

Body param

SourceParams param.Field[InstanceNewParamsSourceParams]Optional

Body param

ExcludeItems []stringOptional

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.

IncludeItems []stringOptional

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.

Prefix stringOptional

R2Jurisdiction stringOptional

WebCrawler InstanceNewParamsSourceParamsWebCrawlerOptional

DiscoverOptions InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsOptional

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

Depth float64Optional

Maximum link-follow depth from the seed URL.

maximum100000

minimum1

IncludeExternalLinks boolOptional

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

IncludeSubdomains boolOptional

Follow links to subdomains of the source host.

Limit float64Optional

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

maximum100000

minimum1

MaxAge float64Optional

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

maximum604800

minimum0

Source InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsSourceOptional

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

One of the following:

const InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsSourceAll InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsSource = "all"

const InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsSourceSitemaps InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsSource = "sitemaps"

const InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsSourceLinks InstanceNewParamsSourceParamsWebCrawlerDiscoverOptionsSource = "links"

ParseOptions InstanceNewParamsSourceParamsWebCrawlerParseOptionsOptional

ContentSelector []InstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelectorOptional

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 string

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

maxLength200

minLength1

Selector string

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

IncludeHeaders map[string, string]Optional

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

IncludeImages boolOptional

SpecificSitemaps []stringOptional

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

UseBrowserRendering boolOptional

ParseType InstanceNewParamsSourceParamsWebCrawlerParseTypeOptional

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:

const InstanceNewParamsSourceParamsWebCrawlerParseTypeSitemap InstanceNewParamsSourceParamsWebCrawlerParseType = "sitemap"

const InstanceNewParamsSourceParamsWebCrawlerParseTypeDiscover InstanceNewParamsSourceParamsWebCrawlerParseType = "discover"

SyncInterval param.Field[InstanceNewParamsSyncInterval]Optional

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

const InstanceNewParamsSyncInterval900 InstanceNewParamsSyncInterval = 900

const InstanceNewParamsSyncInterval1800 InstanceNewParamsSyncInterval = 1800

const InstanceNewParamsSyncInterval3600 InstanceNewParamsSyncInterval = 3600

const InstanceNewParamsSyncInterval7200 InstanceNewParamsSyncInterval = 7200

const InstanceNewParamsSyncInterval14400 InstanceNewParamsSyncInterval = 14400

const InstanceNewParamsSyncInterval21600 InstanceNewParamsSyncInterval = 21600

const InstanceNewParamsSyncInterval43200 InstanceNewParamsSyncInterval = 43200

const InstanceNewParamsSyncInterval86400 InstanceNewParamsSyncInterval = 86400

TokenID param.Field[string]Optional

Body param

formatuuid

Type param.Field[InstanceNewParamsType]Optional

Body param: 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.

const InstanceNewParamsTypeR2 InstanceNewParamsType = "r2"

const InstanceNewParamsTypeWebCrawler InstanceNewParamsType = "web-crawler"

ReturnsExpand Collapse

type InstanceNewResponse struct{…}

ID string

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

maxLength64

minLength1

CreatedAt Time

formatdate-time

ModifiedAt Time

formatdate-time

AIGatewayID stringOptional

AISearchModel stringOptional

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 boolOptional

CacheThreshold InstanceNewResponseCacheThresholdOptional

One of the following:

const InstanceNewResponseCacheThresholdSuperStrictMatch InstanceNewResponseCacheThreshold = "super_strict_match"

const InstanceNewResponseCacheThresholdCloseEnough InstanceNewResponseCacheThreshold = "close_enough"

const InstanceNewResponseCacheThresholdFlexibleFriend InstanceNewResponseCacheThreshold = "flexible_friend"

const InstanceNewResponseCacheThresholdAnythingGoes InstanceNewResponseCacheThreshold = "anything_goes"

CacheTTL InstanceNewResponseCacheTTLOptional

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:

const InstanceNewResponseCacheTTL600 InstanceNewResponseCacheTTL = 600

const InstanceNewResponseCacheTTL1800 InstanceNewResponseCacheTTL = 1800

const InstanceNewResponseCacheTTL3600 InstanceNewResponseCacheTTL = 3600

const InstanceNewResponseCacheTTL7200 InstanceNewResponseCacheTTL = 7200

const InstanceNewResponseCacheTTL21600 InstanceNewResponseCacheTTL = 21600

const InstanceNewResponseCacheTTL43200 InstanceNewResponseCacheTTL = 43200

const InstanceNewResponseCacheTTL86400 InstanceNewResponseCacheTTL = 86400

const InstanceNewResponseCacheTTL172800 InstanceNewResponseCacheTTL = 172800

const InstanceNewResponseCacheTTL259200 InstanceNewResponseCacheTTL = 259200

const InstanceNewResponseCacheTTL518400 InstanceNewResponseCacheTTL = 518400

ChunkOverlap int64Optional

maximum30

minimum0

ChunkSize int64Optional

minimum64

CreatedBy stringOptional

CustomMetadata []InstanceNewResponseCustomMetadataOptional

DataType InstanceNewResponseCustomMetadataDataType

One of the following:

const InstanceNewResponseCustomMetadataDataTypeText InstanceNewResponseCustomMetadataDataType = "text"

const InstanceNewResponseCustomMetadataDataTypeNumber InstanceNewResponseCustomMetadataDataType = "number"

const InstanceNewResponseCustomMetadataDataTypeBoolean InstanceNewResponseCustomMetadataDataType = "boolean"

const InstanceNewResponseCustomMetadataDataTypeDatetime InstanceNewResponseCustomMetadataDataType = "datetime"

FieldName string

maxLength64

minLength1

EmbeddingModel stringOptional

Enable boolOptional

EngineVersion float64Optional

FusionMethod InstanceNewResponseFusionMethodOptional

One of the following:

const InstanceNewResponseFusionMethodMax InstanceNewResponseFusionMethod = "max"

const InstanceNewResponseFusionMethodRrf InstanceNewResponseFusionMethod = "rrf"

DeprecatedHybridSearchEnabled boolOptional

Deprecated — use index_method instead. Defaults to true for new instances; set false to create a vector-only instance.

IndexMethod InstanceNewResponseIndexMethodOptional

Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.

Keyword bool

Enable keyword (BM25) storage backend.

Vector bool

Enable vector (embedding) storage backend.

IndexingOptions InstanceNewResponseIndexingOptionsOptional

KeywordTokenizer InstanceNewResponseIndexingOptionsKeywordTokenizerOptional

One of the following:

const InstanceNewResponseIndexingOptionsKeywordTokenizerPorter InstanceNewResponseIndexingOptionsKeywordTokenizer = "porter"

const InstanceNewResponseIndexingOptionsKeywordTokenizerTrigram InstanceNewResponseIndexingOptionsKeywordTokenizer = "trigram"

UseOCR boolOptional

Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.

LastActivity TimeOptional

formatdate-time

MaxNumResults int64Optional

maximum50

minimum1

Metadata InstanceNewResponseMetadataOptional

CreatedFromAISearchWizard boolOptional

WorkerDomain stringOptional

ModifiedBy stringOptional

Namespace stringOptional

Paused boolOptional

PublicEndpointID stringOptional

PublicEndpointParams InstanceNewResponsePublicEndpointParamsOptional

AuthorizedHosts []stringOptional

ChatCompletionsEndpoint InstanceNewResponsePublicEndpointParamsChatCompletionsEndpointOptional

Disabled boolOptional

Disable chat completions endpoint for this public endpoint

CustomDomains []stringOptional

DefaultDomainEnabled boolOptional

Enabled boolOptional

Mcp InstanceNewResponsePublicEndpointParamsMcpOptional

Description stringOptional

Disabled boolOptional

Disable MCP endpoint for this public endpoint

RateLimit InstanceNewResponsePublicEndpointParamsRateLimitOptional

PeriodMs int64Optional

maximum3600000

minimum60000

Requests int64Optional

minimum1

Technique InstanceNewResponsePublicEndpointParamsRateLimitTechniqueOptional

One of the following:

const InstanceNewResponsePublicEndpointParamsRateLimitTechniqueFixed InstanceNewResponsePublicEndpointParamsRateLimitTechnique = "fixed"

const InstanceNewResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceNewResponsePublicEndpointParamsRateLimitTechnique = "sliding"

SearchEndpoint InstanceNewResponsePublicEndpointParamsSearchEndpointOptional

Disabled boolOptional

Disable search endpoint for this public endpoint

Reranking boolOptional

RerankingModel stringOptional

RetrievalOptions InstanceNewResponseRetrievalOptionsOptional

BoostBy []InstanceNewResponseRetrievalOptionsBoostByOptional

Field string

maxLength64

minLength1

Direction InstanceNewResponseRetrievalOptionsBoostByDirectionOptional

One of the following:

const InstanceNewResponseRetrievalOptionsBoostByDirectionAsc InstanceNewResponseRetrievalOptionsBoostByDirection = "asc"

const InstanceNewResponseRetrievalOptionsBoostByDirectionDesc InstanceNewResponseRetrievalOptionsBoostByDirection = "desc"

const InstanceNewResponseRetrievalOptionsBoostByDirectionExists InstanceNewResponseRetrievalOptionsBoostByDirection = "exists"

const InstanceNewResponseRetrievalOptionsBoostByDirectionNotExists InstanceNewResponseRetrievalOptionsBoostByDirection = "not_exists"

KeywordMatchMode InstanceNewResponseRetrievalOptionsKeywordMatchModeOptional

One of the following:

const InstanceNewResponseRetrievalOptionsKeywordMatchModeAnd InstanceNewResponseRetrievalOptionsKeywordMatchMode = "and"

const InstanceNewResponseRetrievalOptionsKeywordMatchModeOr InstanceNewResponseRetrievalOptionsKeywordMatchMode = "or"

RewriteModel stringOptional

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.

RewriteQuery boolOptional

ScoreThreshold float64Optional

maximum1

minimum0

Source stringOptional

SourceParams InstanceNewResponseSourceParamsOptional

ExcludeItems []stringOptional

IncludeItems []stringOptional

Prefix stringOptional

R2Jurisdiction stringOptional

WebCrawler InstanceNewResponseSourceParamsWebCrawlerOptional

DiscoverOptions InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsOptional

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

Depth float64Optional

Maximum link-follow depth from the seed URL.

maximum100000

minimum1

IncludeExternalLinks boolOptional

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

IncludeSubdomains boolOptional

Follow links to subdomains of the source host.

Limit float64Optional

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

maximum100000

minimum1

MaxAge float64Optional

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

maximum604800

minimum0

Source InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsSourceOptional

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

One of the following:

const InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsSourceAll InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsSource = "all"

const InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsSourceSitemaps InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsSource = "sitemaps"

const InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsSourceLinks InstanceNewResponseSourceParamsWebCrawlerDiscoverOptionsSource = "links"

ParseOptions InstanceNewResponseSourceParamsWebCrawlerParseOptionsOptional

ContentSelector []InstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelectorOptional

Path string

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

maxLength200

minLength1

Selector string

maxLength200

minLength1

IncludeHeaders map[string, string]Optional

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

IncludeImages boolOptional

SpecificSitemaps []stringOptional

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

UseBrowserRendering boolOptional

ParseType InstanceNewResponseSourceParamsWebCrawlerParseTypeOptional

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:

const InstanceNewResponseSourceParamsWebCrawlerParseTypeSitemap InstanceNewResponseSourceParamsWebCrawlerParseType = "sitemap"

const InstanceNewResponseSourceParamsWebCrawlerParseTypeDiscover InstanceNewResponseSourceParamsWebCrawlerParseType = "discover"

Status stringOptional

SyncInterval InstanceNewResponseSyncIntervalOptional

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:

const InstanceNewResponseSyncInterval900 InstanceNewResponseSyncInterval = 900

const InstanceNewResponseSyncInterval1800 InstanceNewResponseSyncInterval = 1800

const InstanceNewResponseSyncInterval3600 InstanceNewResponseSyncInterval = 3600

const InstanceNewResponseSyncInterval7200 InstanceNewResponseSyncInterval = 7200

const InstanceNewResponseSyncInterval14400 InstanceNewResponseSyncInterval = 14400

const InstanceNewResponseSyncInterval21600 InstanceNewResponseSyncInterval = 21600

const InstanceNewResponseSyncInterval43200 InstanceNewResponseSyncInterval = 43200

const InstanceNewResponseSyncInterval86400 InstanceNewResponseSyncInterval = 86400

TokenID stringOptional

formatuuid

Type InstanceNewResponseTypeOptional

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:

const InstanceNewResponseTypeR2 InstanceNewResponseType = "r2"

const InstanceNewResponseTypeWebCrawler InstanceNewResponseType = "web-crawler"

Create an AI Search instance (Search for Agents requires the default namespace).

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai_search"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  instance, err := client.AISearch.Instances.New(context.TODO(), ai_search.InstanceNewParams{
    AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"),
    ID: cloudflare.F("my-ai-search"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", instance.ID)
}

{
  "result": {
    "id": "my-ai-search",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "ai_gateway_id": "ai_gateway_id",
    "ai_search_model": "ai_search_model",
    "cache": true,
    "cache_threshold": "super_strict_match",
    "cache_ttl": 600,
    "chunk_overlap": 0,
    "chunk_size": 64,
    "created_by": "created_by",
    "custom_metadata": [
      {
        "data_type": "text",
        "field_name": "x"
      }
    ],
    "embedding_model": "embedding_model",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter",
      "use_ocr": true
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 1,
    "metadata": {
      "created_from_aisearch_wizard": true,
      "worker_domain": "worker_domain"
    },
    "modified_by": "modified_by",
    "namespace": "namespace",
    "paused": true,
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "custom_domains": [
        "search.example.com"
      ],
      "default_domain_enabled": true,
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "reranking_model",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "rewrite_model",
    "rewrite_query": true,
    "score_threshold": 0,
    "source": "source",
    "source_params": {
      "exclude_items": [
        "/admin/**",
        "/private/**",
        "**\\temp\\**"
      ],
      "include_items": [
        "/blog/**",
        "/docs/**/*.html",
        "**\\blog\\**.html"
      ],
      "prefix": "prefix",
      "r2_jurisdiction": "r2_jurisdiction",
      "web_crawler": {
        "discover_options": {
          "depth": 5,
          "include_external_links": false,
          "include_subdomains": false,
          "limit": 10000,
          "max_age": 86400,
          "source": "all"
        },
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article div.post-body"
            },
            {
              "path": "**/docs/**",
              "selector": "main"
            }
          ],
          "include_headers": {
            "cache-control": "no-cache, no-store"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap"
      }
    },
    "status": "status",
    "sync_interval": 900,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}

Returns Examples

{
  "result": {
    "id": "my-ai-search",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "ai_gateway_id": "ai_gateway_id",
    "ai_search_model": "ai_search_model",
    "cache": true,
    "cache_threshold": "super_strict_match",
    "cache_ttl": 600,
    "chunk_overlap": 0,
    "chunk_size": 64,
    "created_by": "created_by",
    "custom_metadata": [
      {
        "data_type": "text",
        "field_name": "x"
      }
    ],
    "embedding_model": "embedding_model",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter",
      "use_ocr": true
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 1,
    "metadata": {
      "created_from_aisearch_wizard": true,
      "worker_domain": "worker_domain"
    },
    "modified_by": "modified_by",
    "namespace": "namespace",
    "paused": true,
    "public_endpoint_id": "public_endpoint_id",
    "public_endpoint_params": {
      "authorized_hosts": [
        "string"
      ],
      "chat_completions_endpoint": {
        "disabled": true
      },
      "custom_domains": [
        "search.example.com"
      ],
      "default_domain_enabled": true,
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "reranking_model",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "rewrite_model",
    "rewrite_query": true,
    "score_threshold": 0,
    "source": "source",
    "source_params": {
      "exclude_items": [
        "/admin/**",
        "/private/**",
        "**\\temp\\**"
      ],
      "include_items": [
        "/blog/**",
        "/docs/**/*.html",
        "**\\blog\\**.html"
      ],
      "prefix": "prefix",
      "r2_jurisdiction": "r2_jurisdiction",
      "web_crawler": {
        "discover_options": {
          "depth": 5,
          "include_external_links": false,
          "include_subdomains": false,
          "limit": 10000,
          "max_age": 86400,
          "source": "all"
        },
        "parse_options": {
          "content_selector": [
            {
              "path": "**/blog/**",
              "selector": "article div.post-body"
            },
            {
              "path": "**/docs/**",
              "selector": "main"
            }
          ],
          "include_headers": {
            "cache-control": "no-cache, no-store"
          },
          "include_images": true,
          "specific_sitemaps": [
            "https://example.com/sitemap.xml",
            "https://example.com/blog-sitemap.xml"
          ],
          "use_browser_rendering": true
        },
        "parse_type": "sitemap"
      }
    },
    "status": "status",
    "sync_interval": 900,
    "token_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "r2"
  },
  "success": true
}