API Reference

Vectorize

Indexes

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Metadata 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