Read instance.

client.AISearch.Namespaces.Instances.Read(ctx, name, id, query) (*NamespaceInstanceReadResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}

Read instance.

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

name string

id string

query NamespaceInstanceReadParams

AccountID param.Field[string]

ReturnsExpand Collapse

type NamespaceInstanceReadResponse 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 NamespaceInstanceReadResponseAISearchModelOptional

One of the following:

const NamespaceInstanceReadResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceReadResponseAISearchModelCfZaiOrgGlm4_7Flash NamespaceInstanceReadResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceReadResponseAISearchModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceReadResponseAISearchModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceReadResponseAISearchModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceReadResponseAISearchModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceReadResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceReadResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceReadResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceReadResponseAISearchModelCfMoonshotaiKimiK2Instruct NamespaceInstanceReadResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceReadResponseAISearchModelCfGoogleGemma3_12bIt NamespaceInstanceReadResponseAISearchModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceReadResponseAISearchModelCfGoogleGemma4_26bA4bIt NamespaceInstanceReadResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceReadResponseAISearchModelCfMoonshotaiKimiK2_5 NamespaceInstanceReadResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceReadResponseAISearchModelAnthropicClaude3_7Sonnet NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceReadResponseAISearchModelAnthropicClaudeSonnet4 NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceReadResponseAISearchModelAnthropicClaudeOpus4 NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-opus-4"

const NamespaceInstanceReadResponseAISearchModelAnthropicClaude3_5Haiku NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceReadResponseAISearchModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceReadResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceReadResponseAISearchModelCerebrasQwen3_235bA22bThinking NamespaceInstanceReadResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceReadResponseAISearchModelCerebrasLlama3_3_70b NamespaceInstanceReadResponseAISearchModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceReadResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceReadResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceReadResponseAISearchModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceReadResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceReadResponseAISearchModelCerebrasGptOSs120b NamespaceInstanceReadResponseAISearchModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceReadResponseAISearchModelGoogleAIStudioGemini2_5Flash NamespaceInstanceReadResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceReadResponseAISearchModelGoogleAIStudioGemini2_5Pro NamespaceInstanceReadResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceReadResponseAISearchModelGrokGrok4 NamespaceInstanceReadResponseAISearchModel = "grok/grok-4"

const NamespaceInstanceReadResponseAISearchModelGroqLlama3_3_70bVersatile NamespaceInstanceReadResponseAISearchModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceReadResponseAISearchModelGroqLlama3_1_8bInstant NamespaceInstanceReadResponseAISearchModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceReadResponseAISearchModelOpenAIGpt5 NamespaceInstanceReadResponseAISearchModel = "openai/gpt-5"

const NamespaceInstanceReadResponseAISearchModelOpenAIGpt5Mini NamespaceInstanceReadResponseAISearchModel = "openai/gpt-5-mini"

const NamespaceInstanceReadResponseAISearchModelOpenAIGpt5Nano NamespaceInstanceReadResponseAISearchModel = "openai/gpt-5-nano"

const NamespaceInstanceReadResponseAISearchModelEmpty NamespaceInstanceReadResponseAISearchModel = ""

Cache boolOptional

CacheThreshold NamespaceInstanceReadResponseCacheThresholdOptional

One of the following:

const NamespaceInstanceReadResponseCacheThresholdSuperStrictMatch NamespaceInstanceReadResponseCacheThreshold = "super_strict_match"

const NamespaceInstanceReadResponseCacheThresholdCloseEnough NamespaceInstanceReadResponseCacheThreshold = "close_enough"

const NamespaceInstanceReadResponseCacheThresholdFlexibleFriend NamespaceInstanceReadResponseCacheThreshold = "flexible_friend"

const NamespaceInstanceReadResponseCacheThresholdAnythingGoes NamespaceInstanceReadResponseCacheThreshold = "anything_goes"

CacheTTL NamespaceInstanceReadResponseCacheTTLOptional

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 NamespaceInstanceReadResponseCacheTTL600 NamespaceInstanceReadResponseCacheTTL = 600

const NamespaceInstanceReadResponseCacheTTL1800 NamespaceInstanceReadResponseCacheTTL = 1800

const NamespaceInstanceReadResponseCacheTTL3600 NamespaceInstanceReadResponseCacheTTL = 3600

const NamespaceInstanceReadResponseCacheTTL7200 NamespaceInstanceReadResponseCacheTTL = 7200

const NamespaceInstanceReadResponseCacheTTL21600 NamespaceInstanceReadResponseCacheTTL = 21600

const NamespaceInstanceReadResponseCacheTTL43200 NamespaceInstanceReadResponseCacheTTL = 43200

const NamespaceInstanceReadResponseCacheTTL86400 NamespaceInstanceReadResponseCacheTTL = 86400

const NamespaceInstanceReadResponseCacheTTL172800 NamespaceInstanceReadResponseCacheTTL = 172800

const NamespaceInstanceReadResponseCacheTTL259200 NamespaceInstanceReadResponseCacheTTL = 259200

const NamespaceInstanceReadResponseCacheTTL518400 NamespaceInstanceReadResponseCacheTTL = 518400

ChunkOverlap int64Optional

maximum30

minimum0

ChunkSize int64Optional

minimum64

CreatedBy stringOptional

CustomMetadata []NamespaceInstanceReadResponseCustomMetadataOptional

DataType NamespaceInstanceReadResponseCustomMetadataDataType

One of the following:

const NamespaceInstanceReadResponseCustomMetadataDataTypeText NamespaceInstanceReadResponseCustomMetadataDataType = "text"

const NamespaceInstanceReadResponseCustomMetadataDataTypeNumber NamespaceInstanceReadResponseCustomMetadataDataType = "number"

const NamespaceInstanceReadResponseCustomMetadataDataTypeBoolean NamespaceInstanceReadResponseCustomMetadataDataType = "boolean"

const NamespaceInstanceReadResponseCustomMetadataDataTypeDatetime NamespaceInstanceReadResponseCustomMetadataDataType = "datetime"

FieldName string

maxLength64

minLength1

EmbeddingModel NamespaceInstanceReadResponseEmbeddingModelOptional

One of the following:

const NamespaceInstanceReadResponseEmbeddingModelCfQwenQwen3Embedding0_6b NamespaceInstanceReadResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"

const NamespaceInstanceReadResponseEmbeddingModelCfQwenQwen3VlEmbedding2b NamespaceInstanceReadResponseEmbeddingModel = "@cf/qwen/qwen3-vl-embedding-2b"

const NamespaceInstanceReadResponseEmbeddingModelCfBaaiBgeM3 NamespaceInstanceReadResponseEmbeddingModel = "@cf/baai/bge-m3"

const NamespaceInstanceReadResponseEmbeddingModelCfBaaiBgeLargeEnV1_5 NamespaceInstanceReadResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"

const NamespaceInstanceReadResponseEmbeddingModelCfGoogleEmbeddinggemma300m NamespaceInstanceReadResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"

const NamespaceInstanceReadResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001 NamespaceInstanceReadResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"

const NamespaceInstanceReadResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceReadResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"

const NamespaceInstanceReadResponseEmbeddingModelOpenAITextEmbedding3Small NamespaceInstanceReadResponseEmbeddingModel = "openai/text-embedding-3-small"

const NamespaceInstanceReadResponseEmbeddingModelOpenAITextEmbedding3Large NamespaceInstanceReadResponseEmbeddingModel = "openai/text-embedding-3-large"

const NamespaceInstanceReadResponseEmbeddingModelEmpty NamespaceInstanceReadResponseEmbeddingModel = ""

Enable boolOptional

EngineVersion float64Optional

FusionMethod NamespaceInstanceReadResponseFusionMethodOptional

One of the following:

const NamespaceInstanceReadResponseFusionMethodMax NamespaceInstanceReadResponseFusionMethod = "max"

const NamespaceInstanceReadResponseFusionMethodRrf NamespaceInstanceReadResponseFusionMethod = "rrf"

DeprecatedHybridSearchEnabled boolOptional

Deprecated — use index_method instead.

IndexMethod NamespaceInstanceReadResponseIndexMethodOptional

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

Keyword bool

Enable keyword (BM25) storage backend.

Vector bool

Enable vector (embedding) storage backend.

IndexingOptions NamespaceInstanceReadResponseIndexingOptionsOptional

KeywordTokenizer NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizerOptional

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 NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizerPorter NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer = "porter"

const NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer = "trigram"

LastActivity TimeOptional

formatdate-time

MaxNumResults int64Optional

maximum50

minimum1

Metadata NamespaceInstanceReadResponseMetadataOptional

CreatedFromAISearchWizard boolOptional

WorkerDomain stringOptional

ModifiedBy stringOptional

Namespace stringOptional

Paused boolOptional

PublicEndpointID stringOptional

PublicEndpointParams NamespaceInstanceReadResponsePublicEndpointParamsOptional

AuthorizedHosts []stringOptional

ChatCompletionsEndpoint NamespaceInstanceReadResponsePublicEndpointParamsChatCompletionsEndpointOptional

Disabled boolOptional

Disable chat completions endpoint for this public endpoint

Enabled boolOptional

Mcp NamespaceInstanceReadResponsePublicEndpointParamsMcpOptional

Description stringOptional

Disabled boolOptional

Disable MCP endpoint for this public endpoint

RateLimit NamespaceInstanceReadResponsePublicEndpointParamsRateLimitOptional

PeriodMs int64Optional

maximum3600000

minimum60000

Requests int64Optional

minimum1

Technique NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechniqueOptional

One of the following:

const NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechniqueFixed NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique = "fixed"

const NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique = "sliding"

SearchEndpoint NamespaceInstanceReadResponsePublicEndpointParamsSearchEndpointOptional

Disabled boolOptional

Disable search endpoint for this public endpoint

Reranking boolOptional

RerankingModel NamespaceInstanceReadResponseRerankingModelOptional

One of the following:

const NamespaceInstanceReadResponseRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceReadResponseRerankingModel = "@cf/baai/bge-reranker-base"

const NamespaceInstanceReadResponseRerankingModelEmpty NamespaceInstanceReadResponseRerankingModel = ""

RetrievalOptions NamespaceInstanceReadResponseRetrievalOptionsOptional

BoostBy []NamespaceInstanceReadResponseRetrievalOptionsBoostByOptional

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 NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionOptional

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 NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionAsc NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "asc"

const NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionDesc NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "desc"

const NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionExists NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "exists"

const NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "not_exists"

KeywordMatchMode NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchModeOptional

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. Defaults to ‘and’.

One of the following:

const NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode = "and"

const NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchModeOr NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode = "or"

RewriteModel NamespaceInstanceReadResponseRewriteModelOptional

One of the following:

const NamespaceInstanceReadResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceReadResponseRewriteModelCfZaiOrgGlm4_7Flash NamespaceInstanceReadResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceReadResponseRewriteModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceReadResponseRewriteModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceReadResponseRewriteModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceReadResponseRewriteModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceReadResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceReadResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceReadResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceReadResponseRewriteModelCfMoonshotaiKimiK2Instruct NamespaceInstanceReadResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceReadResponseRewriteModelCfGoogleGemma3_12bIt NamespaceInstanceReadResponseRewriteModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceReadResponseRewriteModelCfGoogleGemma4_26bA4bIt NamespaceInstanceReadResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceReadResponseRewriteModelCfMoonshotaiKimiK2_5 NamespaceInstanceReadResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceReadResponseRewriteModelAnthropicClaude3_7Sonnet NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceReadResponseRewriteModelAnthropicClaudeSonnet4 NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceReadResponseRewriteModelAnthropicClaudeOpus4 NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-opus-4"

const NamespaceInstanceReadResponseRewriteModelAnthropicClaude3_5Haiku NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceReadResponseRewriteModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceReadResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceReadResponseRewriteModelCerebrasQwen3_235bA22bThinking NamespaceInstanceReadResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceReadResponseRewriteModelCerebrasLlama3_3_70b NamespaceInstanceReadResponseRewriteModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceReadResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceReadResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceReadResponseRewriteModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceReadResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceReadResponseRewriteModelCerebrasGptOSs120b NamespaceInstanceReadResponseRewriteModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceReadResponseRewriteModelGoogleAIStudioGemini2_5Flash NamespaceInstanceReadResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceReadResponseRewriteModelGoogleAIStudioGemini2_5Pro NamespaceInstanceReadResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceReadResponseRewriteModelGrokGrok4 NamespaceInstanceReadResponseRewriteModel = "grok/grok-4"

const NamespaceInstanceReadResponseRewriteModelGroqLlama3_3_70bVersatile NamespaceInstanceReadResponseRewriteModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceReadResponseRewriteModelGroqLlama3_1_8bInstant NamespaceInstanceReadResponseRewriteModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceReadResponseRewriteModelOpenAIGpt5 NamespaceInstanceReadResponseRewriteModel = "openai/gpt-5"

const NamespaceInstanceReadResponseRewriteModelOpenAIGpt5Mini NamespaceInstanceReadResponseRewriteModel = "openai/gpt-5-mini"

const NamespaceInstanceReadResponseRewriteModelOpenAIGpt5Nano NamespaceInstanceReadResponseRewriteModel = "openai/gpt-5-nano"

const NamespaceInstanceReadResponseRewriteModelEmpty NamespaceInstanceReadResponseRewriteModel = ""

RewriteQuery boolOptional

ScoreThreshold float64Optional

maximum1

minimum0

Source stringOptional

SourceParams NamespaceInstanceReadResponseSourceParamsOptional

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)

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)

Prefix stringOptional

R2Jurisdiction stringOptional

WebCrawler NamespaceInstanceReadResponseSourceParamsWebCrawlerOptional

ParseOptions NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsOptional

ContentSelector []NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelectorOptional

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 NamespaceInstanceReadResponseSourceParamsWebCrawlerParseTypeOptional

One of the following:

const NamespaceInstanceReadResponseSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType = "sitemap"

const NamespaceInstanceReadResponseSourceParamsWebCrawlerParseTypeCrawl NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType = "crawl"

Status stringOptional

SyncInterval NamespaceInstanceReadResponseSyncIntervalOptional

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 NamespaceInstanceReadResponseSyncInterval900 NamespaceInstanceReadResponseSyncInterval = 900

const NamespaceInstanceReadResponseSyncInterval1800 NamespaceInstanceReadResponseSyncInterval = 1800

const NamespaceInstanceReadResponseSyncInterval3600 NamespaceInstanceReadResponseSyncInterval = 3600

const NamespaceInstanceReadResponseSyncInterval7200 NamespaceInstanceReadResponseSyncInterval = 7200

const NamespaceInstanceReadResponseSyncInterval14400 NamespaceInstanceReadResponseSyncInterval = 14400

const NamespaceInstanceReadResponseSyncInterval21600 NamespaceInstanceReadResponseSyncInterval = 21600

const NamespaceInstanceReadResponseSyncInterval43200 NamespaceInstanceReadResponseSyncInterval = 43200

const NamespaceInstanceReadResponseSyncInterval86400 NamespaceInstanceReadResponseSyncInterval = 86400

TokenID stringOptional

formatuuid

Type NamespaceInstanceReadResponseTypeOptional

One of the following:

const NamespaceInstanceReadResponseTypeR2 NamespaceInstanceReadResponseType = "r2"

const NamespaceInstanceReadResponseTypeWebCrawler NamespaceInstanceReadResponseType = "web-crawler"

Read instance.

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.AISearch.Namespaces.Instances.Read(
    context.TODO(),
    "my-namespace",
    "my-ai-search",
    ai_search.NamespaceInstanceReadParams{
      AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.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": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "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": "@cf/qwen/qwen3-embedding-0.6b",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 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
      },
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "@cf/baai/bge-reranker-base",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "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": {
        "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": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "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": "@cf/qwen/qwen3-embedding-0.6b",
    "enable": true,
    "engine_version": 0,
    "fusion_method": "max",
    "hybrid_search_enabled": true,
    "index_method": {
      "keyword": true,
      "vector": true
    },
    "indexing_options": {
      "keyword_tokenizer": "porter"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "max_num_results": 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
      },
      "enabled": true,
      "mcp": {
        "description": "description",
        "disabled": true
      },
      "rate_limit": {
        "period_ms": 60000,
        "requests": 1,
        "technique": "fixed"
      },
      "search_endpoint": {
        "disabled": true
      }
    },
    "reranking": true,
    "reranking_model": "@cf/baai/bge-reranker-base",
    "retrieval_options": {
      "boost_by": [
        {
          "field": "timestamp",
          "direction": "desc"
        }
      ],
      "keyword_match_mode": "and"
    },
    "rewrite_model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "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": {
        "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
}