Skip to content
Cloudflare API
Start here
API Reference
Vectorize

Indexes

List Vectorize Indexes
vectorize.indexes.list(IndexListParams**kwargs) -> SyncSinglePage[CreateIndex]
GET/accounts/{account_id}/vectorize/v2/indexes
Get Vectorize Index
vectorize.indexes.get(strindex_name, IndexGetParams**kwargs) -> CreateIndex
GET/accounts/{account_id}/vectorize/v2/indexes/{index_name}
Create Vectorize Index
vectorize.indexes.create(IndexCreateParams**kwargs) -> CreateIndex
POST/accounts/{account_id}/vectorize/v2/indexes
Delete Vectorize Index
vectorize.indexes.delete(strindex_name, IndexDeleteParams**kwargs) -> IndexDeleteResponse
DELETE/accounts/{account_id}/vectorize/v2/indexes/{index_name}
Insert Vectors
vectorize.indexes.insert(strindex_name, IndexInsertParams**kwargs) -> IndexInsertResponse
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert
Query Vectors
vectorize.indexes.query(strindex_name, IndexQueryParams**kwargs) -> IndexQueryResponse
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query
Upsert Vectors
vectorize.indexes.upsert(strindex_name, IndexUpsertParams**kwargs) -> IndexUpsertResponse
POST/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert
Delete Vectors By Identifier
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
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
vectorize.indexes.info(strindex_name, IndexInfoParams**kwargs) -> IndexInfoResponse
GET/accounts/{account_id}/vectorize/v2/indexes/{index_name}/info
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[IndexDimensionConfiguration]
created_on: Optional[datetime]

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

formatdate-time
description: Optional[str]

Specifies the description of the index.

modified_on: Optional[datetime]

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

formatdate-time
name: Optional[str]
class IndexDeleteVectorsByID: …
count: Optional[int]

The count of the vectors successfully deleted.

ids: Optional[List[str]]

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

class IndexDimensionConfiguration: …
dimensions: int

Specifies the number of dimensions for the index

maximum1536
minimum1
metric: Literal["cosine", "euclidean", "dot-product"]

Specifies the type of metric to use calculating distance.

One of the following:
"cosine"
"euclidean"
"dot-product"
class IndexInsert: …
count: Optional[int]

Specifies the count of the vectors successfully inserted.

ids: Optional[List[str]]

Array of vector identifiers of the vectors successfully inserted.

class IndexQuery: …
count: Optional[int]

Specifies the count of vectors returned by the search

matches: Optional[List[Match]]

Array of vectors matched by the search

id: Optional[str]

Identifier for a Vector

maxLength64
metadata: Optional[object]
score: Optional[float]

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

values: Optional[List[float]]
class IndexUpsert: …
count: Optional[int]

Specifies the count of the vectors successfully inserted.

ids: Optional[List[str]]

Array of vector identifiers of the vectors successfully inserted.

Union[str, object, null]
One of the following:
str
object
class IndexInsertResponse: …
mutation_id: Optional[str]

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

maxLength36
class IndexQueryResponse: …
count: Optional[int]

Specifies the count of vectors returned by the search

matches: Optional[List[Match]]

Array of vectors matched by the search

id: Optional[str]

Identifier for a Vector

maxLength64
metadata: Optional[object]
namespace: Optional[str]
score: Optional[float]

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

values: Optional[List[float]]
class IndexUpsertResponse: …
mutation_id: Optional[str]

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

maxLength36
class IndexDeleteByIDsResponse: …
mutation_id: Optional[str]

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

maxLength36
class IndexInfoResponse: …
dimensions: Optional[int]

Specifies the number of dimensions for the index

maximum1536
minimum1
processed_up_to_datetime: Optional[datetime]

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

formatdate-time
processed_up_to_mutation: Optional[str]

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

maxLength36
vector_count: Optional[int]

Specifies the number of vectors present in the index

class IndexListVectorsResponse: …
count: int

Number of vectors returned in this response

is_truncated: bool

Whether there are more vectors available beyond this response

total_count: int

Total number of vectors in the index

vectors: List[Vector]

Array of vector items

id: str

Identifier for a Vector

maxLength64
cursor_expiration_timestamp: Optional[datetime]

When the cursor expires as an ISO8601 string

formatdate-time
next_cursor: Optional[str]

Cursor for the next page of results

IndexesMetadata Index

List Metadata Indexes
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
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
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"
"number"
"boolean"
property_name: Optional[str]

Specifies the indexed metadata property.

class MetadataIndexCreateResponse: …
mutation_id: Optional[str]

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

maxLength36
class MetadataIndexDeleteResponse: …
mutation_id: Optional[str]

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

maxLength36