---
title: Vectorize
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Vectorize
#### VectorizeIndexes
##### [List Vectorize Indexes](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/list)
GET/accounts/{account\_id}/vectorize/v2/indexes
##### [Get Vectorize Index](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/get)
GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}
##### [Create Vectorize Index](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/create)
POST/accounts/{account\_id}/vectorize/v2/indexes
##### [Delete Vectorize Index](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/delete)
DELETE/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}
##### [Insert Vectors](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/insert)
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/insert
##### [Query Vectors](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/query)
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/query
##### [Upsert Vectors](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/upsert)
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/upsert
##### [Delete Vectors By Identifier](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/delete_by_ids)
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/delete\_by\_ids
##### [Get Vectors By Identifier](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/get_by_ids)
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/get\_by\_ids
##### [Get Vectorize Index Info](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/info)
GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/info
##### [List Vectors](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/list_vectors)
GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/list
##### ModelsExpand Collapse
CreateIndex object {config, created\_on, description, 2 more }
config: optional object {dimensions, metric, preset }
dimensions: number
Specifies the number of dimensions for the index
maximum1536
minimum1
Link to this property
metric: "cosine"or "euclidean"or "dot-product"
Specifies the type of metric to use calculating distance.
One of the following:
"cosine"
Link to this property
"euclidean"
Link to this property
"dot-product"
Link to this property
Link to this property
preset: optional "@cf/baai/bge-small-en-v1.5"or "@cf/baai/bge-base-en-v1.5"or "@cf/baai/bge-large-en-v1.5"or 2 more
Specifies the preset to use for the index.
One of the following:
"@cf/baai/bge-small-en-v1.5"
Link to this property
"@cf/baai/bge-base-en-v1.5"
Link to this property
"@cf/baai/bge-large-en-v1.5"
Link to this property
"openai/text-embedding-ada-002"
Link to this property
"cohere/embed-multilingual-v2.0"
Link to this property
Link to this property
Link to this property
created\_on: optional string
Specifies the timestamp the resource was created as an ISO8601 string.
formatdate-time
Link to this property
description: optional string
Specifies the description of the index.
Link to this property
modified\_on: optional string
Specifies the timestamp the resource was modified as an ISO8601 string.
formatdate-time
Link to this property
name: optional string
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20create_index%20%3E%20(schema)>)
IndexDeleteVectorsByID object {count, ids }
count: optional number
The count of the vectors successfully deleted.
Link to this property
ids: optional array of string
Array of vector identifiers of the vectors that were successfully processed for deletion.
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_delete_vectors_by_id%20%3E%20(schema)>)
IndexDimensionConfiguration object {dimensions, metric }
dimensions: number
Specifies the number of dimensions for the index
maximum1536
minimum1
Link to this property
metric: "cosine"or "euclidean"or "dot-product"
Specifies the type of metric to use calculating distance.
One of the following:
"cosine"
Link to this property
"euclidean"
Link to this property
"dot-product"
Link to this property
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_dimension_configuration%20%3E%20(schema)>)
IndexInsert object {count, ids }
count: optional number
Specifies the count of the vectors successfully inserted.
Link to this property
ids: optional array of string
Array of vector identifiers of the vectors successfully inserted.
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_insert%20%3E%20(schema)>)
IndexQuery object {count, matches }
count: optional number
Specifies the count of vectors returned by the search
Link to this property
matches: optional array of object {id, metadata, score, values }
Array of vectors matched by the search
id: optional string
Identifier for a Vector
maxLength64
Link to this property
metadata: optional unknown
Link to this property
score: optional number
The score of the vector according to the index’s distance metric
Link to this property
values: optional array of number
Link to this property
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_query%20%3E%20(schema)>)
IndexUpsert object {count, ids }
count: optional number
Specifies the count of the vectors successfully inserted.
Link to this property
ids: optional array of string
Array of vector identifiers of the vectors successfully inserted.
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_upsert%20%3E%20(schema)>)
IndexDeleteResponse = unknownor string
One of the following:
unknown
Link to this property
string
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_delete_response%20%3E%20(schema)>)
IndexInsertResponse object {mutationId }
mutationId: optional string
The unique identifier for the async mutation operation containing the changeset.
maxLength36
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_insert_response%20%3E%20(schema)>)
IndexQueryResponse object {count, matches }
count: optional number
Specifies the count of vectors returned by the search
Link to this property
matches: optional array of object {id, metadata, namespace, 2 more }
Array of vectors matched by the search
id: optional string
Identifier for a Vector
maxLength64
Link to this property
metadata: optional unknown
Link to this property
namespace: optional string
Link to this property
score: optional number
The score of the vector according to the index’s distance metric
Link to this property
values: optional array of number
Link to this property
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_query_response%20%3E%20(schema)>)
IndexUpsertResponse object {mutationId }
mutationId: optional string
The unique identifier for the async mutation operation containing the changeset.
maxLength36
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_upsert_response%20%3E%20(schema)>)
IndexDeleteByIDsResponse object {mutationId }
mutationId: optional string
The unique identifier for the async mutation operation containing the changeset.
maxLength36
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_delete_by_ids_response%20%3E%20(schema)>)
IndexGetByIDsResponse = unknown
Array of vectors with matching ids.
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_get_by_ids_response%20%3E%20(schema)>)
IndexInfoResponse object {dimensions, processedUpToDatetime, processedUpToMutation, vectorCount }
dimensions: optional number
Specifies the number of dimensions for the index
maximum1536
minimum1
Link to this property
processedUpToDatetime: optional string
Specifies the timestamp the last mutation batch was processed as an ISO8601 string.
formatdate-time
Link to this property
processedUpToMutation: optional string
The unique identifier for the async mutation operation containing the changeset.
maxLength36
Link to this property
vectorCount: optional number
Specifies the number of vectors present in the index
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_info_response%20%3E%20(schema)>)
IndexListVectorsResponse object {count, isTruncated, totalCount, 3 more }
count: number
Number of vectors returned in this response
Link to this property
isTruncated: boolean
Whether there are more vectors available beyond this response
Link to this property
totalCount: number
Total number of vectors in the index
Link to this property
vectors: array of object {id }
Array of vector items
id: string
Identifier for a Vector
maxLength64
Link to this property
Link to this property
cursorExpirationTimestamp: optional string
When the cursor expires as an ISO8601 string
formatdate-time
Link to this property
nextCursor: optional string
Cursor for the next page of results
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_list_vectors_response%20%3E%20(schema)>)
#### VectorizeIndexesMetadata Index
##### [List Metadata Indexes](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/list)
GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/metadata\_index/list
##### [Create Metadata Index](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/create)
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/metadata\_index/create
##### [Delete Metadata Index](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/delete)
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/metadata\_index/delete
##### ModelsExpand Collapse
MetadataIndexListResponse object {metadataIndexes }
metadataIndexes: optional array of object {indexType, propertyName }
Array of indexed metadata properties.
indexType: optional "string"or "number"or "boolean"
Specifies the type of indexed metadata property.
One of the following:
"string"
Link to this property
"number"
Link to this property
"boolean"
Link to this property
Link to this property
propertyName: optional string
Specifies the indexed metadata property.
Link to this property
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes.metadata_index%20%3E%20(model)%20metadata_index_list_response%20%3E%20(schema)>)
MetadataIndexCreateResponse object {mutationId }
mutationId: optional string
The unique identifier for the async mutation operation containing the changeset.
maxLength36
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes.metadata_index%20%3E%20(model)%20metadata_index_create_response%20%3E%20(schema)>)
MetadataIndexDeleteResponse object {mutationId }
mutationId: optional string
The unique identifier for the async mutation operation containing the changeset.
maxLength36
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes.metadata_index%20%3E%20(model)%20metadata_index_delete_response%20%3E%20(schema)>)