Vectorize

Last updated Apr 23, 2026 Interact with a Vectorize vector database using Wrangler.

vectorize create

Create a Vectorize index

npmyarnpnpm

npx wrangler vectorize create <NAME>
yarn wrangler vectorize create <NAME>
pnpm wrangler vectorize create <NAME>
  • <NAME> string required

The name of the Vectorize index to create (must be unique). - --dimensions number The dimension size to configure this index for, based on the output dimensions of your ML model. - --metric string The distance metric to use for searching within the index. - --preset string The name of an preset representing an embeddings model: Vectorize will configure the dimensions and distance metric for you when provided. - --description string An optional description for this index. - --json boolean default: false

Return output as JSON - --deprecated-v1 boolean default: false

Create a deprecated Vectorize V1 index. This is not recommended and indexes created with this option need all other Vectorize operations to have this option enabled. - --use-remote boolean Use a remote binding when adding the newly created resource to your config - --update-config boolean Automatically update your config file with the newly added resource - --binding string The binding name of this resource in your Worker

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

vectorize delete

Delete a Vectorize index

npmyarnpnpm

npx wrangler vectorize delete <NAME>
yarn wrangler vectorize delete <NAME>
pnpm wrangler vectorize delete <NAME>
  • <NAME> string required

The name of the Vectorize index - --force boolean alias: --ydefault: false

Skip confirmation - --deprecated-v1 boolean default: false

Delete a deprecated Vectorize V1 index.

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

vectorize get

Get a Vectorize index by name

npmyarnpnpm

npx wrangler vectorize get <NAME>
yarn wrangler vectorize get <NAME>
pnpm wrangler vectorize get <NAME>
  • <NAME> string required

The name of the Vectorize index. - --json boolean default: false

Return output as JSON - --deprecated-v1 boolean default: false

Fetch a deprecated V1 Vectorize index. This must be enabled if the index was created with V1 option.

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

vectorize list

List your Vectorize indexes

npmyarnpnpm

npx wrangler vectorize list
yarn wrangler vectorize list
pnpm wrangler vectorize list
  • --json boolean default: false

Return output as JSON - --deprecated-v1 boolean default: false

List deprecated Vectorize V1 indexes for your account.

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

vectorize list-vectors

List vector identifiers in a Vectorize index

npmyarnpnpm

npx wrangler vectorize list-vectors <NAME>
yarn wrangler vectorize list-vectors <NAME>
pnpm wrangler vectorize list-vectors <NAME>
  • <NAME> string required

The name of the Vectorize index - --count number Maximum number of vectors to return (1-1000) - --cursor string Cursor for pagination to get the next page of results - --json boolean default: false

Return output as JSON

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

vectorize query

Query a Vectorize index

npmyarnpnpm

npx wrangler vectorize query <NAME>
yarn wrangler vectorize query <NAME>
pnpm wrangler vectorize query <NAME>
  • <NAME> string required

The name of the Vectorize index - --vector number Vector to query the Vectorize Index - --vector-id string Identifier for a vector in the index against which the index should be queried - --top-k number default: 5

The number of results (nearest neighbors) to return - --return-values boolean default: false

Specify if the vector values should be included in the results - --return-metadata string default: none

Specify if the vector metadata should be included in the results - --namespace string Filter the query results based on this namespace - --filter string Filter the query results based on this metadata filter.

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

vectorize insert

Insert vectors into a Vectorize index

npmyarnpnpm

npx wrangler vectorize insert <NAME>
yarn wrangler vectorize insert <NAME>
pnpm wrangler vectorize insert <NAME>
  • <NAME> string required

The name of the Vectorize index. - --file string required

A file containing line separated json (ndjson) vector objects. - --batch-size number default: 1000

Number of vector records to include when sending to the Cloudflare API. - --json boolean default: false

return output as JSON - --deprecated-v1 boolean default: false

Insert into a deprecated V1 Vectorize index. This must be enabled if the index was created with the V1 option.

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

vectorize upsert

Upsert vectors into a Vectorize index

npmyarnpnpm

npx wrangler vectorize upsert <NAME>
yarn wrangler vectorize upsert <NAME>
pnpm wrangler vectorize upsert <NAME>
  • <NAME> string required