Skip to content
Cloudflare API
Start here
API Reference

Vectorize

VectorizeIndexes

List Vectorize Indexes
client.vectorize.indexes.list(IndexListParams { account_id } params, RequestOptionsoptions?): SinglePage<CreateIndex { config, created_on, description, 2 more } >
GET/accounts/{account_id}/vectorize/v2/indexes
Get Vectorize Index
client.vectorize.indexes.get(stringindexName, IndexGetParams { account_id } params, RequestOptionsoptions?): CreateIndex { config, created_on, description, 2 more } | null
GET/accounts/{account_id}/vectorize/v2/indexes/{index_name}
Create Vectorize Index
client.vectorize.indexes.create(IndexCreateParams { account_id, config, name, description } params, RequestOptionsoptions?): CreateIndex { config, created_on, description, 2 more } | null
POST/accounts/{account_id}/vectorize/v2/indexes
Delete Vectorize Index
client.vectorize.indexes.delete(stringindexName, IndexDeleteParams { account_id } params, RequestOptionsoptions?): IndexDeleteResponse | null
DELETE/accounts/{account_id}/vectorize/v2/indexes/{index_name}
Insert Vectors
client.vectorize.indexes.insert(stringindexName, IndexInsertParams { account_id, body, unparsableBehavior } params, RequestOptionsoptions?): IndexInsertResponse { mutationId } | null
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert
Query Vectors
client.vectorize.indexes.query(stringindexName, IndexQueryParams { account_id, vector, filter, 3 more } params, RequestOptionsoptions?): IndexQueryResponse { count, matches } | null
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query
Upsert Vectors
client.vectorize.indexes.upsert(stringindexName, IndexUpsertParams { account_id, body, unparsableBehavior } params, RequestOptionsoptions?): IndexUpsertResponse { mutationId } | null
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert
Delete Vectors By Identifier
client.vectorize.indexes.deleteByIds(stringindexName, IndexDeleteByIDsParams { account_id, ids } params, RequestOptionsoptions?): IndexDeleteByIDsResponse { mutationId } | null
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids
Get Vectors By Identifier
client.vectorize.indexes.getByIds(stringindexName, IndexGetByIDsParams { account_id, ids } params, RequestOptionsoptions?): IndexGetByIDsResponse | null
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids
Get Vectorize Index Info
client.vectorize.indexes.info(stringindexName, IndexInfoParams { account_id } params, RequestOptionsoptions?): IndexInfoResponse { dimensions, processedUpToDatetime, processedUpToMutation, vectorCount } | null
GET/accounts/{account_id}/vectorize/v2/indexes/{index_name}/info
List Vectors
client.vectorize.indexes.listVectors(stringindexName, IndexListVectorsParams { account_id, count, cursor } params, RequestOptionsoptions?): IndexListVectorsResponse { count, isTruncated, totalCount, 3 more } | null
GET/accounts/{account_id}/vectorize/v2/indexes/{index_name}/list
ModelsExpand Collapse
CreateIndex { config, created_on, description, 2 more }
config?: IndexDimensionConfiguration { dimensions, metric }
created_on?: string

Specifies the timestamp the resource was created as an ISO8601 string.

formatdate-time
description?: string

Specifies the description of the index.

modified_on?: string

Specifies the timestamp the resource was modified as an ISO8601 string.

formatdate-time
name?: string
IndexDeleteVectorsByID { count, ids }
count?: number

The count of the vectors successfully deleted.

ids?: Array<string>

Array of vector identifiers of the vectors that were successfully processed for deletion.

IndexDimensionConfiguration { dimensions, metric }
dimensions: number

Specifies the number of dimensions for the index

maximum1536
minimum1
metric: "cosine" | "euclidean" | "dot-product"

Specifies the type of metric to use calculating distance.

One of the following:
"cosine"
"euclidean"
"dot-product"
IndexInsert { count, ids }
count?: number

Specifies the count of the vectors successfully inserted.

ids?: Array<string>

Array of vector identifiers of the vectors successfully inserted.

IndexQuery { count, matches }
count?: number

Specifies the count of vectors returned by the search

matches?: Array<Match>

Array of vectors matched by the search

id?: string

Identifier for a Vector

maxLength64
metadata?: unknown
score?: number

The score of the vector according to the index's distance metric

values?: Array<number> | null
IndexUpsert { count, ids }
count?: number

Specifies the count of the vectors successfully inserted.

ids?: Array<string>

Array of vector identifiers of the vectors successfully inserted.

IndexDeleteResponse = unknown | string | null
One of the following:
unknown
string
IndexInsertResponse { mutationId }
mutationId?: string

The unique identifier for the async mutation operation containing the changeset.

maxLength36
IndexQueryResponse { count, matches }
count?: number

Specifies the count of vectors returned by the search

matches?: Array<Match>

Array of vectors matched by the search

id?: string

Identifier for a Vector

maxLength64
metadata?: unknown
namespace?: string | null
score?: number

The score of the vector according to the index's distance metric

values?: Array<number> | null
IndexUpsertResponse { mutationId }
mutationId?: string

The unique identifier for the async mutation operation containing the changeset.

maxLength36
IndexDeleteByIDsResponse { mutationId }
mutationId?: string

The unique identifier for the async mutation operation containing the changeset.

maxLength36
IndexGetByIDsResponse = unknown

Array of vectors with matching ids.

IndexInfoResponse { dimensions, processedUpToDatetime, processedUpToMutation, vectorCount }
dimensions?: number

Specifies the number of dimensions for the index

maximum1536
minimum1
processedUpToDatetime?: string | null

Specifies the timestamp the last mutation batch was processed as an ISO8601 string.

formatdate-time
processedUpToMutation?: string

The unique identifier for the async mutation operation containing the changeset.

maxLength36
vectorCount?: number

Specifies the number of vectors present in the index

IndexListVectorsResponse { count, isTruncated, totalCount, 3 more }
count: number

Number of vectors returned in this response

isTruncated: boolean

Whether there are more vectors available beyond this response

totalCount: number

Total number of vectors in the index

vectors: Array<Vector>

Array of vector items

id: string

Identifier for a Vector

maxLength64
cursorExpirationTimestamp?: string | null

When the cursor expires as an ISO8601 string

formatdate-time
nextCursor?: string | null

Cursor for the next page of results

VectorizeIndexesMetadata Index

List Metadata Indexes
client.vectorize.indexes.metadataIndex.list(stringindexName, MetadataIndexListParams { account_id } params, RequestOptionsoptions?): MetadataIndexListResponse { metadataIndexes } | null
GET/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list
Create Metadata Index
client.vectorize.indexes.metadataIndex.create(stringindexName, MetadataIndexCreateParams { account_id, indexType, propertyName } params, RequestOptionsoptions?): MetadataIndexCreateResponse { mutationId } | null
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create
Delete Metadata Index
client.vectorize.indexes.metadataIndex.delete(stringindexName, MetadataIndexDeleteParams { account_id, propertyName } params, RequestOptionsoptions?): MetadataIndexDeleteResponse { mutationId } | null
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete
ModelsExpand Collapse
MetadataIndexListResponse { metadataIndexes }
metadataIndexes?: Array<MetadataIndex>

Array of indexed metadata properties.

indexType?: "string" | "number" | "boolean"

Specifies the type of indexed metadata property.

One of the following:
"string"
"number"
"boolean"
propertyName?: string

Specifies the indexed metadata property.

MetadataIndexCreateResponse { mutationId }
mutationId?: string

The unique identifier for the async mutation operation containing the changeset.

maxLength36
MetadataIndexDeleteResponse { mutationId }
mutationId?: string

The unique identifier for the async mutation operation containing the changeset.

maxLength36