Viewing docs for Cloudflare v6.19.0
published on Thursday, Aug 6, 2026 by Pulumi
published on Thursday, Aug 6, 2026 by Pulumi
Viewing docs for Cloudflare v6.19.0
published on Thursday, Aug 6, 2026 by Pulumi
published on Thursday, Aug 6, 2026 by Pulumi
Using getAiSearchInstance
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAiSearchInstance(args: GetAiSearchInstanceArgs, opts?: InvokeOptions): Promise<GetAiSearchInstanceResult>
function getAiSearchInstanceOutput(args: GetAiSearchInstanceOutputArgs, opts?: InvokeOutputOptions): Output<GetAiSearchInstanceResult>def get_ai_search_instance(account_id: Optional[str] = None,
filter: Optional[GetAiSearchInstanceFilter] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAiSearchInstanceResult
def get_ai_search_instance_output(account_id: pulumi.Input[Optional[str]] = None,
filter: pulumi.Input[Optional[GetAiSearchInstanceFilterArgs]] = None,
id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetAiSearchInstanceResult]func LookupAiSearchInstance(ctx *Context, args *LookupAiSearchInstanceArgs, opts ...InvokeOption) (*LookupAiSearchInstanceResult, error)
func LookupAiSearchInstanceOutput(ctx *Context, args *LookupAiSearchInstanceOutputArgs, opts ...InvokeOption) LookupAiSearchInstanceResultOutput> Note: This function is named LookupAiSearchInstance in the Go SDK.
public static class GetAiSearchInstance
{
public static Task<GetAiSearchInstanceResult> InvokeAsync(GetAiSearchInstanceArgs args, InvokeOptions? opts = null)
public static Output<GetAiSearchInstanceResult> Invoke(GetAiSearchInstanceInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetAiSearchInstanceResult> Invoke(GetAiSearchInstanceInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetAiSearchInstanceResult> getAiSearchInstance(GetAiSearchInstanceArgs args, InvokeOptions options)
public static Output<GetAiSearchInstanceResult> getAiSearchInstance(GetAiSearchInstanceArgs args, InvokeOptions options)
public static Output<GetAiSearchInstanceResult> getAiSearchInstance(GetAiSearchInstanceArgs args, InvokeOutputOptions options)
fn::invoke:
function: cloudflare:index/getAiSearchInstance:getAiSearchInstance
arguments:
# arguments dictionarydata "cloudflare_get_ai_search_instance" "name" {
# arguments
}The following arguments are supported:
- Account
Id string - Filter
Get
Ai Search Instance Filter - Id string
- The ID of this resource.
- Account
Id string - Filter
Get
Ai Search Instance Filter - Id string
- The ID of this resource.
- account_
id string - filter object
- id string
- The ID of this resource.
- account
Id String - filter
Get
Ai Search Instance Filter - id String
- The ID of this resource.
- account
Id string - filter
Get
Ai Search Instance Filter - id string
- The ID of this resource.
- account_
id str - filter
Get
Ai Search Instance Filter - id str
- The ID of this resource.
- account
Id String - filter Property Map
- id String
- The ID of this resource.
getAiSearchInstance Result
The following output properties are available:
- Ai
Gateway stringId - Aisearch
Model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- Cache bool
- Cache
Threshold string - Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
- Cache
Ttl double - 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). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
- Chunk
Overlap int - Chunk
Size int - Created
At string - Created
By string - Custom
Metadatas List<GetAi Search Instance Custom Metadata> - Embedding
Model string - Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/qwen/qwen3-vl-embedding-2b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "google-ai-studio/gemini-embedding-2", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
- Enable bool
- Engine
Version double - Fusion
Method string - Available values: "max", "rrf".
- Hybrid
Search boolEnabled - Deprecated — use indexMethod instead.
- Id string
- The ID of this resource.
- Index
Method GetAi Search Instance Index Method - Controls which storage backends are used during indexing. Defaults to vector-only.
- Indexing
Options GetAi Search Instance Indexing Options - Last
Activity string - Max
Num intResults - Metadata
Get
Ai Search Instance Metadata - Modified
At string - Modified
By string - Namespace string
- Paused bool
- Public
Endpoint stringId - Public
Endpoint GetParams Ai Search Instance Public Endpoint Params - Reranking bool
- Reranking
Model string - Available values: "@cf/baai/bge-reranker-base", "".
- Retrieval
Options GetAi Search Instance Retrieval Options - Rewrite
Model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- Rewrite
Query bool - Score
Threshold double - Source string
- Source
Params GetAi Search Instance Source Params - Status string
- Sync
Interval double - Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
- Token
Id string - Type string
- Available values: "r2", "web-crawler".
- Account
Id string - Filter
Get
Ai Search Instance Filter
- Ai
Gateway stringId - Aisearch
Model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- Cache bool
- Cache
Threshold string - Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
- Cache
Ttl float64 - 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). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
- Chunk
Overlap int - Chunk
Size int - Created
At string - Created
By string - Custom
Metadatas []GetAi Search Instance Custom Metadata - Embedding
Model string - Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/qwen/qwen3-vl-embedding-2b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "google-ai-studio/gemini-embedding-2", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
- Enable bool
- Engine
Version float64 - Fusion
Method string - Available values: "max", "rrf".
- Hybrid
Search boolEnabled - Deprecated — use indexMethod instead.
- Id string
- The ID of this resource.
- Index
Method GetAi Search Instance Index Method - Controls which storage backends are used during indexing. Defaults to vector-only.
- Indexing
Options GetAi Search Instance Indexing Options - Last
Activity string - Max
Num intResults - Metadata
Get
Ai Search Instance Metadata - Modified
At string - Modified
By string - Namespace string
- Paused bool
- Public
Endpoint stringId - Public
Endpoint GetParams Ai Search Instance Public Endpoint Params - Reranking bool
- Reranking
Model string - Available values: "@cf/baai/bge-reranker-base", "".
- Retrieval
Options GetAi Search Instance Retrieval Options - Rewrite
Model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- Rewrite
Query bool - Score
Threshold float64 - Source string
- Source
Params GetAi Search Instance Source Params - Status string
- Sync
Interval float64 - Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
- Token
Id string - Type string
- Available values: "r2", "web-crawler".
- Account
Id string - Filter
Get
Ai Search Instance Filter
- ai_
gateway_ stringid - aisearch_
model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- cache bool
- cache_
threshold string - Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
- cache_
ttl 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). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
- chunk_
overlap number - chunk_
size number - created_
at string - created_
by string - custom_
metadatas list(object) - embedding_
model string - Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/qwen/qwen3-vl-embedding-2b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "google-ai-studio/gemini-embedding-2", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
- enable bool
- engine_
version number - fusion_
method string - Available values: "max", "rrf".
- hybrid_
search_ boolenabled - Deprecated — use indexMethod instead.
- id string
- The ID of this resource.
- index_
method object - Controls which storage backends are used during indexing. Defaults to vector-only.
- indexing_
options object - last_
activity string - max_
num_ numberresults - metadata object
- modified_
at string - modified_
by string - namespace string
- paused bool
- public_
endpoint_ stringid - public_
endpoint_ objectparams - reranking bool
- reranking_
model string - Available values: "@cf/baai/bge-reranker-base", "".
- retrieval_
options object - rewrite_
model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- rewrite_
query bool - score_
threshold number - source string
- source_
params object - status string
- sync_
interval number - Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
- token_
id string - type string
- Available values: "r2", "web-crawler".
- account_
id string - filter object
- ai
Gateway StringId - aisearch
Model String - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- cache Boolean
- cache
Threshold String - Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
- cache
Ttl Double - 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). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
- chunk
Overlap Integer - chunk
Size Integer - created
At String - created
By String - custom
Metadatas List<GetAi Search Instance Custom Metadata> - embedding
Model String - Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/qwen/qwen3-vl-embedding-2b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "google-ai-studio/gemini-embedding-2", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
- enable Boolean
- engine
Version Double - fusion
Method String - Available values: "max", "rrf".
- hybrid
Search BooleanEnabled - Deprecated — use indexMethod instead.
- id String
- The ID of this resource.
- index
Method GetAi Search Instance Index Method - Controls which storage backends are used during indexing. Defaults to vector-only.
- indexing
Options GetAi Search Instance Indexing Options - last
Activity String - max
Num IntegerResults - metadata
Get
Ai Search Instance Metadata - modified
At String - modified
By String - namespace String
- paused Boolean
- public
Endpoint StringId - public
Endpoint GetParams Ai Search Instance Public Endpoint Params - reranking Boolean
- reranking
Model String - Available values: "@cf/baai/bge-reranker-base", "".
- retrieval
Options GetAi Search Instance Retrieval Options - rewrite
Model String - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- rewrite
Query Boolean - score
Threshold Double - source String
- source
Params GetAi Search Instance Source Params - status String
- sync
Interval Double - Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
- token
Id String - type String
- Available values: "r2", "web-crawler".
- account
Id String - filter
Get
Ai Search Instance Filter
- ai
Gateway stringId - aisearch
Model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- cache boolean
- cache
Threshold string - Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
- cache
Ttl 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). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
- chunk
Overlap number - chunk
Size number - created
At string - created
By string - custom
Metadatas GetAi Search Instance Custom Metadata[] - embedding
Model string - Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/qwen/qwen3-vl-embedding-2b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "google-ai-studio/gemini-embedding-2", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
- enable boolean
- engine
Version number - fusion
Method string - Available values: "max", "rrf".
- hybrid
Search booleanEnabled - Deprecated — use indexMethod instead.
- id string
- The ID of this resource.
- index
Method GetAi Search Instance Index Method - Controls which storage backends are used during indexing. Defaults to vector-only.
- indexing
Options GetAi Search Instance Indexing Options - last
Activity string - max
Num numberResults - metadata
Get
Ai Search Instance Metadata - modified
At string - modified
By string - namespace string
- paused boolean
- public
Endpoint stringId - public
Endpoint GetParams Ai Search Instance Public Endpoint Params - reranking boolean
- reranking
Model string - Available values: "@cf/baai/bge-reranker-base", "".
- retrieval
Options GetAi Search Instance Retrieval Options - rewrite
Model string - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- rewrite
Query boolean - score
Threshold number - source string
- source
Params GetAi Search Instance Source Params - status string
- sync
Interval number - Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
- token
Id string - type string
- Available values: "r2", "web-crawler".
- account
Id string - filter
Get
Ai Search Instance Filter
- ai_
gateway_ strid - aisearch_
model str - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- cache bool
- cache_
threshold str - Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
- cache_
ttl float - 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). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
- chunk_
overlap int - chunk_
size int - created_
at str - created_
by str - custom_
metadatas Sequence[GetAi Search Instance Custom Metadata] - embedding_
model str - Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/qwen/qwen3-vl-embedding-2b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "google-ai-studio/gemini-embedding-2", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
- enable bool
- engine_
version float - fusion_
method str - Available values: "max", "rrf".
- hybrid_
search_ boolenabled - Deprecated — use indexMethod instead.
- id str
- The ID of this resource.
- index_
method GetAi Search Instance Index Method - Controls which storage backends are used during indexing. Defaults to vector-only.
- indexing_
options GetAi Search Instance Indexing Options - last_
activity str - max_
num_ intresults - metadata
Get
Ai Search Instance Metadata - modified_
at str - modified_
by str - namespace str
- paused bool
- public_
endpoint_ strid - public_
endpoint_ Getparams Ai Search Instance Public Endpoint Params - reranking bool
- reranking_
model str - Available values: "@cf/baai/bge-reranker-base", "".
- retrieval_
options GetAi Search Instance Retrieval Options - rewrite_
model str - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- rewrite_
query bool - score_
threshold float - source str
- source_
params GetAi Search Instance Source Params - status str
- sync_
interval float - Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
- token_
id str - type str
- Available values: "r2", "web-crawler".
- account_
id str - filter
Get
Ai Search Instance Filter
- ai
Gateway StringId - aisearch
Model String - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- cache Boolean
- cache
Threshold String - Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
- cache
Ttl 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). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
- chunk
Overlap Number - chunk
Size Number - created
At String - created
By String - custom
Metadatas List<Property Map> - embedding
Model String - Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/qwen/qwen3-vl-embedding-2b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "google-ai-studio/gemini-embedding-2", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
- enable Boolean
- engine
Version Number - fusion
Method String - Available values: "max", "rrf".
- hybrid
Search BooleanEnabled - Deprecated — use indexMethod instead.
- id String
- The ID of this resource.
- index
Method Property Map - Controls which storage backends are used during indexing. Defaults to vector-only.
- indexing
Options Property Map - last
Activity String - max
Num NumberResults - metadata Property Map
- modified
At String - modified
By String - namespace String
- paused Boolean
- public
Endpoint StringId - public
Endpoint Property MapParams - reranking Boolean
- reranking
Model String - Available values: "@cf/baai/bge-reranker-base", "".
- retrieval
Options Property Map - rewrite
Model String - Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
- rewrite
Query Boolean - score
Threshold Number - source String
- source
Params Property Map - status String
- sync
Interval Number - Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
- token
Id String - type String
- Available values: "r2", "web-crawler".
- account
Id String - filter Property Map
Supporting Types
GetAiSearchInstanceCustomMetadata
- data_
type string - Available values: "text", "number", "boolean", "datetime".
- field_
name string
- data_
type str - Available values: "text", "number", "boolean", "datetime".
- field_
name str
GetAiSearchInstanceFilter
- Order
By string - Field to order results by. Available values: "createdAt".
- Order
By stringDirection - Order direction. Available values: "asc", "desc".
- Namespace string
- Filter by namespace.
- Search string
- Filter instances whose id contains this string (case-insensitive).
- Order
By string - Field to order results by. Available values: "createdAt".
- Order
By stringDirection - Order direction. Available values: "asc", "desc".
- Namespace string
- Filter by namespace.
- Search string
- Filter instances whose id contains this string (case-insensitive).
- order_
by string - Field to order results by. Available values: "createdAt".
- order_
by_ stringdirection - Order direction. Available values: "asc", "desc".
- namespace string
- Filter by namespace.
- search string
- Filter instances whose id contains this string (case-insensitive).
- order
By String - Field to order results by. Available values: "createdAt".
- order
By StringDirection - Order direction. Available values: "asc", "desc".
- namespace String
- Filter by namespace.
- search String
- Filter instances whose id contains this string (case-insensitive).
- order
By string - Field to order results by. Available values: "createdAt".
- order
By stringDirection - Order direction. Available values: "asc", "desc".
- namespace string
- Filter by namespace.
- search string
- Filter instances whose id contains this string (case-insensitive).
- order_
by str - Field to order results by. Available values: "createdAt".
- order_
by_ strdirection - Order direction. Available values: "asc", "desc".
- namespace str
- Filter by namespace.
- search str
- Filter instances whose id contains this string (case-insensitive).
- order
By String - Field to order results by. Available values: "createdAt".
- order
By StringDirection - Order direction. Available values: "asc", "desc".
- namespace String
- Filter by namespace.
- search String
- Filter instances whose id contains this string (case-insensitive).
GetAiSearchInstanceIndexMethod
GetAiSearchInstanceIndexingOptions
- Keyword
Tokenizer string - 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. Available values: "porter", "trigram".
- Keyword
Tokenizer string - 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. Available values: "porter", "trigram".
- keyword_
tokenizer string - 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. Available values: "porter", "trigram".
- keyword
Tokenizer String - 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. Available values: "porter", "trigram".
- keyword
Tokenizer string - 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. Available values: "porter", "trigram".
- keyword_
tokenizer str - 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. Available values: "porter", "trigram".
- keyword
Tokenizer String - 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. Available values: "porter", "trigram".
GetAiSearchInstanceMetadata
- Created
From boolAisearch Wizard - Worker
Domain string
- Created
From boolAisearch Wizard - Worker
Domain string
- created_
from_ boolaisearch_ wizard - worker_
domain string
- created
From BooleanAisearch Wizard - worker
Domain String
- created
From booleanAisearch Wizard - worker
Domain string
- created
From BooleanAisearch Wizard - worker
Domain String
GetAiSearchInstancePublicEndpointParams
- List<string>
- Chat
Completions GetEndpoint Ai Search Instance Public Endpoint Params Chat Completions Endpoint - Custom
Domains List<string> - 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).
- Default
Domain boolEnabled - When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
- Enabled bool
- Mcp
Get
Ai Search Instance Public Endpoint Params Mcp - Rate
Limit GetAi Search Instance Public Endpoint Params Rate Limit - Search
Endpoint GetAi Search Instance Public Endpoint Params Search Endpoint
- []string
- Chat
Completions GetEndpoint Ai Search Instance Public Endpoint Params Chat Completions Endpoint - Custom
Domains []string - 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).
- Default
Domain boolEnabled - When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
- Enabled bool
- Mcp
Get
Ai Search Instance Public Endpoint Params Mcp - Rate
Limit GetAi Search Instance Public Endpoint Params Rate Limit - Search
Endpoint GetAi Search Instance Public Endpoint Params Search Endpoint
- list(string)
- chat_
completions_ objectendpoint - custom_
domains list(string) - 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).
- default_
domain_ boolenabled - When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
- enabled bool
- mcp object
- rate_
limit object - search_
endpoint object
- List<String>
- chat
Completions GetEndpoint Ai Search Instance Public Endpoint Params Chat Completions Endpoint - custom
Domains List<String> - 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).
- default
Domain BooleanEnabled - When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
- enabled Boolean
- mcp
Get
Ai Search Instance Public Endpoint Params Mcp - rate
Limit GetAi Search Instance Public Endpoint Params Rate Limit - search
Endpoint GetAi Search Instance Public Endpoint Params Search Endpoint
- string[]
- chat
Completions GetEndpoint Ai Search Instance Public Endpoint Params Chat Completions Endpoint - custom
Domains string[] - 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).
- default
Domain booleanEnabled - When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
- enabled boolean
- mcp
Get
Ai Search Instance Public Endpoint Params Mcp - rate
Limit GetAi Search Instance Public Endpoint Params Rate Limit - search
Endpoint GetAi Search Instance Public Endpoint Params Search Endpoint
- Sequence[str]
- chat_
completions_ Getendpoint Ai Search Instance Public Endpoint Params Chat Completions Endpoint - custom_
domains Sequence[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).
- default_
domain_ boolenabled - When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
- enabled bool
- mcp
Get
Ai Search Instance Public Endpoint Params Mcp - rate_
limit GetAi Search Instance Public Endpoint Params Rate Limit - search_
endpoint GetAi Search Instance Public Endpoint Params Search Endpoint
- List<String>
- chat
Completions Property MapEndpoint - custom
Domains List<String> - 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).
- default
Domain BooleanEnabled - When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
- enabled Boolean
- mcp Property Map
- rate
Limit Property Map - search
Endpoint Property Map
GetAiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
- Disabled bool
- Disable chat completions endpoint for this public endpoint
- Disabled bool
- Disable chat completions endpoint for this public endpoint
- disabled bool
- Disable chat completions endpoint for this public endpoint
- disabled Boolean
- Disable chat completions endpoint for this public endpoint
- disabled boolean
- Disable chat completions endpoint for this public endpoint
- disabled bool
- Disable chat completions endpoint for this public endpoint
- disabled Boolean
- Disable chat completions endpoint for this public endpoint
GetAiSearchInstancePublicEndpointParamsMcp
- Description string
- Disabled bool
- Disable MCP endpoint for this public endpoint
- Description string
- Disabled bool
- Disable MCP endpoint for this public endpoint
- description string
- disabled bool
- Disable MCP endpoint for this public endpoint
- description String
- disabled Boolean
- Disable MCP endpoint for this public endpoint
- description string
- disabled boolean
- Disable MCP endpoint for this public endpoint
- description str
- disabled bool
- Disable MCP endpoint for this public endpoint
- description String
- disabled Boolean
- Disable MCP endpoint for this public endpoint
GetAiSearchInstancePublicEndpointParamsRateLimit
GetAiSearchInstancePublicEndpointParamsSearchEndpoint
- Disabled bool
- Disable search endpoint for this public endpoint
- Disabled bool
- Disable search endpoint for this public endpoint
- disabled bool
- Disable search endpoint for this public endpoint
- disabled Boolean
- Disable search endpoint for this public endpoint
- disabled boolean
- Disable search endpoint for this public endpoint
- disabled bool
- Disable search endpoint for this public endpoint
- disabled Boolean
- Disable search endpoint for this public endpoint
GetAiSearchInstanceRetrievalOptions
- Boost
Bies List<GetAi Search Instance Retrieval Options Boost By> - 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.
- Keyword
Match stringMode - 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'. Available values: "and", "or".
- Boost
Bies []GetAi Search Instance Retrieval Options Boost By - 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.
- Keyword
Match stringMode - 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'. Available values: "and", "or".
- boost_
bies list(object) - 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.
- keyword_
match_ stringmode - 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'. Available values: "and", "or".
- boost
Bies List<GetAi Search Instance Retrieval Options Boost By> - 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.
- keyword
Match StringMode - 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'. Available values: "and", "or".
- boost
Bies GetAi Search Instance Retrieval Options Boost By[] - 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.
- keyword
Match stringMode - 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'. Available values: "and", "or".
- boost_
bies Sequence[GetAi Search Instance Retrieval Options Boost By] - 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.
- keyword_
match_ strmode - 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'. Available values: "and", "or".
- boost
Bies List<Property Map> - 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.
- keyword
Match StringMode - 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'. Available values: "and", "or".
GetAiSearchInstanceRetrievalOptionsBoostBy
- Direction string
- Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".
- Field string
- Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
- Direction string
- Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".
- Field string
- Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
- direction string
- Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".
- field string
- Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
- direction String
- Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".
- field String
- Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
- direction string
- Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".
- field string
- Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
- direction str
- Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".
- field str
- Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
- direction String
- Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional — defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".
- field String
- Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
GetAiSearchInstanceSourceParams
- Exclude
Items List<string> - 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)
- Include
Items List<string> - 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 string
- R2Jurisdiction string
- Web
Crawler GetAi Search Instance Source Params Web Crawler
- Exclude
Items []string - 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)
- Include
Items []string - 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 string
- R2Jurisdiction string
- Web
Crawler GetAi Search Instance Source Params Web Crawler
- exclude_
items list(string) - 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)
- include_
items list(string) - 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 string
- r2_
jurisdiction string - web_
crawler object
- exclude
Items List<String> - 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)
- include
Items List<String> - 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 String
- r2Jurisdiction String
- web
Crawler GetAi Search Instance Source Params Web Crawler
- exclude
Items string[] - 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)
- include
Items string[] - 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 string
- r2Jurisdiction string
- web
Crawler GetAi Search Instance Source Params Web Crawler
- exclude_
items Sequence[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)
- include_
items Sequence[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)
- prefix str
- r2_
jurisdiction str - web_
crawler GetAi Search Instance Source Params Web Crawler
- exclude
Items List<String> - 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)
- include
Items List<String> - 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 String
- r2Jurisdiction String
- web
Crawler Property Map
GetAiSearchInstanceSourceParamsWebCrawler
- Parse
Options GetAi Search Instance Source Params Web Crawler Parse Options - Parse
Type string - Available values: "sitemap", "discover".
- Store
Options GetAi Search Instance Source Params Web Crawler Store Options
- Parse
Options GetAi Search Instance Source Params Web Crawler Parse Options - Parse
Type string - Available values: "sitemap", "discover".
- Store
Options GetAi Search Instance Source Params Web Crawler Store Options
- parse_
options object - parse_
type string - Available values: "sitemap", "discover".
- store_
options object
- parse
Options GetAi Search Instance Source Params Web Crawler Parse Options - parse
Type String - Available values: "sitemap", "discover".
- store
Options GetAi Search Instance Source Params Web Crawler Store Options
- parse
Options GetAi Search Instance Source Params Web Crawler Parse Options - parse
Type string - Available values: "sitemap", "discover".
- store
Options GetAi Search Instance Source Params Web Crawler Store Options
- parse_
options GetAi Search Instance Source Params Web Crawler Parse Options - parse_
type str - Available values: "sitemap", "discover".
- store_
options GetAi Search Instance Source Params Web Crawler Store Options
- parse
Options Property Map - parse
Type String - Available values: "sitemap", "discover".
- store
Options Property Map
GetAiSearchInstanceSourceParamsWebCrawlerParseOptions
- Content
Selectors List<GetAi Search Instance Source Params Web Crawler Parse Options Content Selector> - 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.
- Include
Headers Dictionary<string, string> - 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).
- Include
Images bool - Specific
Sitemaps List<string> - List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
- Use
Browser boolRendering
- Content
Selectors []GetAi Search Instance Source Params Web Crawler Parse Options Content Selector - 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.
- Include
Headers map[string]string - 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).
- Include
Images bool - Specific
Sitemaps []string - List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
- Use
Browser boolRendering
- content_
selectors list(object) - 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.
- include_
headers map(string) - 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).
- include_
images bool - specific_
sitemaps list(string) - List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
- use_
browser_ boolrendering
- content
Selectors List<GetAi Search Instance Source Params Web Crawler Parse Options Content Selector> - 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.
- include
Headers Map<String,String> - 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).
- include
Images Boolean - specific
Sitemaps List<String> - List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
- use
Browser BooleanRendering
- content
Selectors GetAi Search Instance Source Params Web Crawler Parse Options Content Selector[] - 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.
- include
Headers {[key: string]: string} - 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).
- include
Images boolean - specific
Sitemaps string[] - List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
- use
Browser booleanRendering
- content_
selectors Sequence[GetAi Search Instance Source Params Web Crawler Parse Options Content Selector] - 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.
- include_
headers Mapping[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).
- include_
images bool - specific_
sitemaps Sequence[str] - List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
- use_
browser_ boolrendering
- content
Selectors List<Property Map> - 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.
- include
Headers Map<String> - 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).
- include
Images Boolean - specific
Sitemaps List<String> - List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
- use
Browser BooleanRendering
GetAiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector
- Path string
- Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
- 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.
- Path string
- Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
- 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.
- path string
- Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
- 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.
- path String
- Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
- 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.
- path string
- Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
- 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.
- path str
- Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
- 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.
- path String
- Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
- 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.
GetAiSearchInstanceSourceParamsWebCrawlerStoreOptions
- R2Jurisdiction string
- Storage
Id string - Storage
Type string - Available values: "r2".
- R2Jurisdiction string
- Storage
Id string - Storage
Type string - Available values: "r2".
- r2_
jurisdiction string - storage_
id string - storage_
type string - Available values: "r2".
- r2Jurisdiction String
- storage
Id String - storage
Type String - Available values: "r2".
- r2Jurisdiction string
- storage
Id string - storage
Type string - Available values: "r2".
- r2_
jurisdiction str - storage_
id str - storage_
type str - Available values: "r2".
- r2Jurisdiction String
- storage
Id String - storage
Type String - Available values: "r2".
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudflareTerraform Provider.
Viewing docs for Cloudflare v6.19.0
published on Thursday, Aug 6, 2026 by Pulumi
published on Thursday, Aug 6, 2026 by Pulumi