--- title: Indexes --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Vectorize](https://developers.cloudflare.com/api/typescript/resources/vectorize) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Indexes ##### [List Vectorize Indexes](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/delete) client.vectorize.indexes.delete(stringindexName, IndexDeleteParams {account\_id } params, RequestOptionsoptions?): [IndexDeleteResponse]()| null DELETE/accounts/{account\_id}/vectorize/v2/indexes/{index\_name} ##### [Insert Vectors](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/insert) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/query) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/upsert) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/delete_by_ids) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/get_by_ids) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/methods/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?: Config {dimensions, metric, preset } dimensions: number Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property
metric: "cosine"| "euclidean"| "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?: "@cf/baai/bge-small-en-v1.5"| "@cf/baai/bge-base-en-v1.5"| "@cf/baai/bge-large-en-v1.5"| 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?: string Specifies the timestamp the resource was created as an ISO8601 string. formatdate-time Link to this property description?: string Specifies the description of the index. Link to this property modified\_on?: string Specifies the timestamp the resource was modified as an ISO8601 string. formatdate-time Link to this property name?: string Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20create_index%20%3E%20(schema)>)
IndexDeleteVectorsByID {count, ids } count?: number The count of the vectors successfully deleted. Link to this property ids?: Array<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 {dimensions, metric } dimensions: number Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property
metric: "cosine"| "euclidean"| "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 {count, ids } count?: number Specifies the count of the vectors successfully inserted. Link to this property ids?: Array<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 {count, matches } count?: number Specifies the count of vectors returned by the search Link to this property
matches?: Array<Match> Array of vectors matched by the search id?: string Identifier for a Vector maxLength64 Link to this property metadata?: unknown Link to this property score?: number The score of the vector according to the index’s distance metric Link to this property values?: Array<number>| null 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 {count, ids } count?: number Specifies the count of the vectors successfully inserted. Link to this property ids?: Array<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 = unknown| string| null 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 {mutationId } mutationId?: 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 {count, matches } count?: number Specifies the count of vectors returned by the search Link to this property
matches?: Array<Match> Array of vectors matched by the search id?: string Identifier for a Vector maxLength64 Link to this property metadata?: unknown Link to this property namespace?: string| null Link to this property score?: number The score of the vector according to the index’s distance metric Link to this property values?: Array<number>| null 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 {mutationId } mutationId?: 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 {mutationId } mutationId?: 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 {dimensions, processedUpToDatetime, processedUpToMutation, vectorCount } dimensions?: number Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property processedUpToDatetime?: string| null Specifies the timestamp the last mutation batch was processed as an ISO8601 string. formatdate-time Link to this property processedUpToMutation?: string The unique identifier for the async mutation operation containing the changeset. maxLength36 Link to this property vectorCount?: 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 {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<Vector> Array of vector items id: string Identifier for a Vector maxLength64 Link to this property
Link to this property cursorExpirationTimestamp?: string| null When the cursor expires as an ISO8601 string formatdate-time Link to this property nextCursor?: string| null 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)>) #### IndexesMetadata Index ##### [List Metadata Indexes](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/delete) 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" Link to this property "number" Link to this property "boolean" Link to this property
Link to this property propertyName?: 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 {mutationId } mutationId?: 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 {mutationId } mutationId?: 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)>)