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

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

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

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"

"number"

"boolean"

propertyName?: string

Specifies the indexed metadata property.

MetadataIndexCreateResponse { mutationId }

mutationId?: string

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

maxLength36

MetadataIndexDeleteResponse { mutationId }

mutationId?: string

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

maxLength36