Cloudflare/ai Search

@swamp/cloudflare/ai-searchv2026.10.23.1· AGPL-3.0-or-later· 3d agoBEHAVIORS

01README

Cloudflare ai-search infrastructure models

02Release Notes

Updated: instances
Updated: namespaces
Updated: tokens

03Behaviors3

instances.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
account_id	string	yes	Cloudflare account ID
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ai_gateway_id?	string	no
ai_search_model?	string	no	A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
cache?	boolean	no
cache_threshold?	enum	no
cache_ttl?	union	no
chunk?	boolean	no
chunk_overlap?	number	no
chunk_size?	number	no
custom_metadata?	array	no
embedding_model?	string	no
fusion_method?	enum	no
index_method?	object	no	Controls which storage backends indexing uses. Defaults to vector and keyword indexing for new instances. When set, both vector and keyword are required.
indexing_options?	object	no
max_num_results?	number	no
metadata?	object	no
paused?	boolean	no
public_endpoint_params?	object	no
reranking?	boolean	no
reranking_model?	string	no
retrieval_options?	object	no
rewrite_model?	string	no	A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
rewrite_query?	boolean	no
score_threshold?	number	no	Minimum similarity score a chunk must reach to be returned. Defaults to 0.4.
source?	string	no
source_params?	object	no
summarization?	boolean	no
summarization_model?	string	no
sync_interval?	union	no
system_prompt_ai_search?	string	no
system_prompt_index_summarization?	string	no
system_prompt_rewrite_query?	string	no
token_id?	string	no
hybrid_search_enabled?	boolean	no	Deprecated — use index_method instead. Defaults to true for new instances; set false to create a vector-only instance.
id?	string	no	AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
type?	enum	no	Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage.
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?	string	no	Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email.
email?	string	no	Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey.

fn create()

Create a Instances

fn get(id: string)

Get a Instances

Argument	Type	Required	Description
id	string	yes	The ID of the Instances

fn lookup(allowMissing?: boolean)

Look up an existing Instances by matching global argument values and import it into state

Argument	Type	Required	Description
allowMissing?	boolean	no	Succeed and record found: false in lookupResult when nothing matches, instead of failing

fn adopt(id: string)

Import an existing Instances by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Instances to import

fn update(identifier?: string)

Update Instances attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific Instances by id (e.g. one discovered by list)

fn delete(id: string)

Delete the Instances

Argument	Type	Required	Description
id	string	yes	The ID of the Instances

fn sync(identifier?: string)

Sync Instances state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Instances by id (e.g. one discovered by list)

Resources

state(infinite)— Instances resource state

lookupResult(infinite)— Outcome of the most recent lookup

namespaces.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
account_id	string	yes	Cloudflare account ID
description?	string	no	Optional description for the namespace. Max 256 characters.
public_endpoint_params?	object	no
name?	string	no
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?	string	no	Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email.
email?	string	no	Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey.

fn create()

Create a Namespaces

fn get(id: string)

Get a Namespaces

Argument	Type	Required	Description
id	string	yes	The ID of the Namespaces

fn lookup(allowMissing?: boolean)

Look up an existing Namespaces by matching global argument values and import it into state

Argument	Type	Required	Description
allowMissing?	boolean	no	Succeed and record found: false in lookupResult when nothing matches, instead of failing

fn adopt(id: string)

Import an existing Namespaces by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Namespaces to import

fn update(identifier?: string)

Update Namespaces attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific Namespaces by id (e.g. one discovered by list)

fn delete(id: string)

Delete the Namespaces

Argument	Type	Required	Description
id	string	yes	The ID of the Namespaces

fn sync(identifier?: string)

Sync Namespaces state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Namespaces by id (e.g. one discovered by list)

Resources

state(infinite)— Namespaces resource state

lookupResult(infinite)— Outcome of the most recent lookup

tokens.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
account_id	string	yes	Cloudflare account ID
cf_api_id?	string	no
cf_api_key?	string	no
legacy?	boolean	no
name?	string	no
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?	string	no	Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email.
email?	string	no	Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey.

fn create()

Create a Tokens

fn get(id: string)

Get a Tokens

Argument	Type	Required	Description
id	string	yes	The ID of the Tokens

fn lookup(allowMissing?: boolean)

Look up an existing Tokens by matching global argument values and import it into state

Argument	Type	Required	Description
allowMissing?	boolean	no	Succeed and record found: false in lookupResult when nothing matches, instead of failing

fn adopt(id: string)

Import an existing Tokens by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Tokens to import

fn update(identifier?: string)

Update Tokens attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific Tokens by id (e.g. one discovered by list)

fn delete(id: string)

Delete the Tokens

Argument	Type	Required	Description
id	string	yes	The ID of the Tokens

fn sync(identifier?: string)

Sync Tokens state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Tokens by id (e.g. one discovered by list)

Resources

state(infinite)— Tokens resource state

lookupResult(infinite)— Outcome of the most recent lookup

04Previous Versions19

2026.10.20.1AGPL-3.0-or-laterOct 20, 2026

Updated: instances
Updated: namespaces
Updated: tokens

Modified 1 behaviors

2026.10.16.2AGPL-3.0-or-laterOct 16, 2026

2026.10.16.1AGPL-3.0-or-later(was none)Oct 16, 2026

Updated: instances

2026.10.13.1Oct 13, 2026

Updated: instances
Updated: namespaces
Updated: tokens

2026.09.29.2Sep 29, 2026

Updated: instances
Updated: namespaces
Updated: tokens

2026.09.29.1Sep 28, 2026

Updated: instances
Updated: namespaces
Updated: tokens

2026.09.25.1Sep 25, 2026

Updated: instances

Modified 1 behaviors

2026.09.11.1Sep 11, 2026

Updated: instances

2026.09.03.1Sep 3, 2026

Updated: instances

2026.08.26.1Aug 26, 2026

Updated: instances

2026.08.25.2Aug 25, 2026

Updated: instances
Updated: namespaces

2026.08.25.1Aug 25, 2026

Updated: instances
Updated: namespaces

2026.08.07.1Aug 7, 2026

Updated: instances

2026.08.02.1Aug 2, 2026

Updated: namespaces

2026.07.28.1Jul 28, 2026

Updated: instances

2026.07.21.1Jul 21, 2026

Updated: instances
Updated: namespaces
Updated: tokens

2026.07.18.2Jul 18, 2026

Modified 1 behaviors

2026.07.14.1Jul 14, 2026

Updated: instances

2026.06.24.1Jun 24, 2026

Updated: instances

05Stats

100 / 100

Downloads

Archive size

24.3 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#cloudflare #ai-search #cloud #infrastructure