Cloudflare API | Vectorize › Indexes › Query Vectors

API Reference

Account & User Management

Resource Sharing

AI

Create Vectorize Index

Delete Vectorize Index

Delete Vectors By Identifier

Get Vectorize Index

Get Vectors By Identifier

Get Vectorize Index Info

List Vectorize Indexes

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Vectorize

vectorize

Indexes

vectorize.indexes

Methods

Create Vectorize Index -> Envelope<

>

post/accounts/{account_id}/vectorize/v2/indexes

Creates and returns a new Vectorize Index.

Delete Vectorize Index -> Envelope<unknown | string>

delete/accounts/{account_id}/vectorize/v2/indexes/{index_name}

Deletes the specified Vectorize Index.

Delete Vectors By Identifier -> Envelope<{ mutationId }>

post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids

Delete a set of vectors from an index by their vector identifiers.

Get Vectorize Index -> Envelope<

>

get/accounts/{account_id}/vectorize/v2/indexes/{index_name}

Returns the specified Vectorize Index.

Get Vectors By Identifier -> Envelope<unknown>

post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids

Get a set of vectors from an index by their vector identifiers.

Get Vectorize Index Info -> Envelope<{ dimensions, processedUpToDatetime, processedUpToMutation, 1 more... }>

get/accounts/{account_id}/vectorize/v2/indexes/{index_name}/info

Get information about a vectorize index.

Insert Vectors -> Envelope<{ mutationId }>

post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert

Inserts vectors into the specified index and returns a mutation id corresponding to the vectors enqueued for insertion.

List Vectorize Indexes -> SinglePage<

>

get/accounts/{account_id}/vectorize/v2/indexes

Returns a list of Vectorize Indexes

Query Vectors -> Envelope<{ count, matches }>

post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query

Finds vectors closest to a given vector in an index.

Security

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Vectorize Write Vectorize Read

Parameters

account_id: string

(maxLength: 32)

Identifier

index_name: string

Body parameters

vector: Array<number>

The search vector that will be used to find the nearest neighbors.

filter: unknown

Optional

A metadata filter expression used to limit nearest neighbor results.

returnMetadata: "none" | "indexed" | "all"

Optional

Whether to return no metadata, indexed metadata or all metadata associated with the closest vectors.

returnValues: boolean

Optional

Whether to return the values associated with the closest vectors.

topK: number

Optional

The number of nearest neighbors to find.

Response fields

errors: Array<

>

messages: Array<

>

result: { count, matches }

success: true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/vectorize/v2/indexes/$INDEX_NAME/query \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "vector": [
        0.5,
        0.5,
        0.5
      ],
      "filter": {
        "has_viewed": {
          "$ne": true
        },
        "streaming_platform": "netflix"
      },
      "topK": 5
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "count": 0,
    "matches": [
      {
        "metadata": {},
        "namespace": "namespace",
        "score": 0,
        "values": [
          0
        ]
      }
    ]
  },
  "success": true
}

Upsert Vectors -> Envelope<{ mutationId }>

post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert

Upserts vectors into the specified index, creating them if they do not exist and returns a mutation id corresponding to the vectors enqueued for upsertion.

Domain types

CreateIndex = { config, created_on, description, 2 more... }

IndexDeleteVectorsByID = { count, ids }

IndexDimensionConfiguration = { dimensions, metric }

IndexInsert = { count, ids }

IndexQuery = { count, matches }

IndexUpsert = { count, ids }

Vectorize Indexes

Metadata Index

vectorize.indexes.metadata_index

Methods

Create Metadata Index -> Envelope<{ mutationId }>

post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create

Enable metadata filtering based on metadata property. Limited to 10 properties.

Delete Metadata Index -> Envelope<{ mutationId }>

post/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete

Allow Vectorize to delete the specified metadata index.

List Metadata Indexes -> Envelope<{ metadataIndexes }>

get/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list

List Metadata Indexes for the specified Vectorize Index.