--- title: Vectorize --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) 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/python/resources/vectorize/subresources/indexes/methods/list) vectorize.indexes.list(IndexListParams\*\*kwargs) -> SyncSinglePage\[[CreateIndex]()] GET/accounts/{account\_id}/vectorize/v2/indexes ##### [Get Vectorize Index](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/get) vectorize.indexes.get(strindex\_name, IndexGetParams\*\*kwargs) -> [CreateIndex]() GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name} ##### [Create Vectorize Index](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/create) vectorize.indexes.create(IndexCreateParams\*\*kwargs) -> [CreateIndex]() POST/accounts/{account\_id}/vectorize/v2/indexes ##### [Delete Vectorize Index](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/delete) vectorize.indexes.delete(strindex\_name, IndexDeleteParams\*\*kwargs) -> [IndexDeleteResponse]() DELETE/accounts/{account\_id}/vectorize/v2/indexes/{index\_name} ##### [Insert Vectors](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/insert) vectorize.indexes.insert(strindex\_name, IndexInsertParams\*\*kwargs) -> [IndexInsertResponse]() POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/insert ##### [Query Vectors](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/query) vectorize.indexes.query(strindex\_name, IndexQueryParams\*\*kwargs) -> [IndexQueryResponse]() POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/query ##### [Upsert Vectors](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/upsert) vectorize.indexes.upsert(strindex\_name, IndexUpsertParams\*\*kwargs) -> [IndexUpsertResponse]() POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/upsert ##### [Delete Vectors By Identifier](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/delete_by_ids) vectorize.indexes.delete\_by\_ids(strindex\_name, IndexDeleteByIDsParams\*\*kwargs) -> [IndexDeleteByIDsResponse]() POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/delete\_by\_ids ##### [Get Vectors By Identifier](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/get_by_ids) vectorize.indexes.get\_by\_ids(strindex\_name, IndexGetByIDsParams\*\*kwargs) -> object POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/get\_by\_ids ##### [Get Vectorize Index Info](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/info) vectorize.indexes.info(strindex\_name, IndexInfoParams\*\*kwargs) -> [IndexInfoResponse]() GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/info ##### [List Vectors](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/methods/list_vectors) vectorize.indexes.list\_vectors(strindex\_name, IndexListVectorsParams\*\*kwargs) -> [IndexListVectorsResponse]() GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/list ##### ModelsExpand Collapse
class CreateIndex: …
config: Optional\[Config] dimensions: int Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property
metric: Literal\["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: Optional\[Literal\["@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: Optional\[datetime] Specifies the timestamp the resource was created as an ISO8601 string. formatdate-time Link to this property description: Optional\[str] Specifies the description of the index. Link to this property modified\_on: Optional\[datetime] Specifies the timestamp the resource was modified as an ISO8601 string. formatdate-time Link to this property name: Optional\[str] Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20create_index%20%3E%20(schema)>)
class IndexDeleteVectorsByID: … count: Optional\[int] The count of the vectors successfully deleted. Link to this property ids: Optional\[List\[str]] 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)>)
class IndexDimensionConfiguration: … dimensions: int Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property
metric: Literal\["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)>)
class IndexInsert: … count: Optional\[int] Specifies the count of the vectors successfully inserted. Link to this property ids: Optional\[List\[str]] 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)>)
class IndexQuery: … count: Optional\[int] Specifies the count of vectors returned by the search Link to this property
matches: Optional\[List\[Match]] Array of vectors matched by the search id: Optional\[str] Identifier for a Vector maxLength64 Link to this property metadata: Optional\[object] Link to this property score: Optional\[float] The score of the vector according to the index’s distance metric Link to this property values: Optional\[List\[float]] 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)>)
class IndexUpsert: … count: Optional\[int] Specifies the count of the vectors successfully inserted. Link to this property ids: Optional\[List\[str]] 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)>)
Union\[str, object, null] One of the following: str Link to this property object Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20index_delete_response%20%3E%20(schema)>)
class IndexInsertResponse: … mutation\_id: Optional\[str] 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)>)
class IndexQueryResponse: … count: Optional\[int] Specifies the count of vectors returned by the search Link to this property
matches: Optional\[List\[Match]] Array of vectors matched by the search id: Optional\[str] Identifier for a Vector maxLength64 Link to this property metadata: Optional\[object] Link to this property namespace: Optional\[str] Link to this property score: Optional\[float] The score of the vector according to the index’s distance metric Link to this property values: Optional\[List\[float]] 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)>)
class IndexUpsertResponse: … mutation\_id: Optional\[str] 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)>)
class IndexDeleteByIDsResponse: … mutation\_id: Optional\[str] 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)>)
class IndexInfoResponse: … dimensions: Optional\[int] Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property processed\_up\_to\_datetime: Optional\[datetime] Specifies the timestamp the last mutation batch was processed as an ISO8601 string. formatdate-time Link to this property processed\_up\_to\_mutation: Optional\[str] The unique identifier for the async mutation operation containing the changeset. maxLength36 Link to this property vector\_count: Optional\[int] 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)>)
class IndexListVectorsResponse: … count: int Number of vectors returned in this response Link to this property is\_truncated: bool Whether there are more vectors available beyond this response Link to this property total\_count: int Total number of vectors in the index Link to this property
vectors: List\[Vector] Array of vector items id: str Identifier for a Vector maxLength64 Link to this property
Link to this property cursor\_expiration\_timestamp: Optional\[datetime] When the cursor expires as an ISO8601 string formatdate-time Link to this property next\_cursor: Optional\[str] 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/python/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/list) vectorize.indexes.metadata\_index.list(strindex\_name, MetadataIndexListParams\*\*kwargs) -> [MetadataIndexListResponse]() GET/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/metadata\_index/list ##### [Create Metadata Index](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/create) vectorize.indexes.metadata\_index.create(strindex\_name, MetadataIndexCreateParams\*\*kwargs) -> [MetadataIndexCreateResponse]() POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/metadata\_index/create ##### [Delete Metadata Index](https://developers.cloudflare.com/api/python/resources/vectorize/subresources/indexes/subresources/metadata_index/methods/delete) vectorize.indexes.metadata\_index.delete(strindex\_name, MetadataIndexDeleteParams\*\*kwargs) -> [MetadataIndexDeleteResponse]() POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/metadata\_index/delete ##### ModelsExpand Collapse
class MetadataIndexListResponse: …
metadata\_indexes: Optional\[List\[MetadataIndex]] Array of indexed metadata properties.
index\_type: Optional\[Literal\["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 property\_name: Optional\[str] 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)>)
class MetadataIndexCreateResponse: … mutation\_id: Optional\[str] 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)>)
class MetadataIndexDeleteResponse: … mutation\_id: Optional\[str] 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)>)