API reference

API reference · API

List vector stores

GET/v1/vector_storesAPI key

Parameters

Path and query parameters
FieldTypeWhat it is
limit (query)integer1 to 100; 20 by default. From 1 to 100.
order (query)stringBy created_at; desc by default. One of "asc", "desc".
after (query)string
before (query)string

Answer 200

A page of stores.

Fields of the 200 answer
FieldTypeWhat it is
object"list"
dataarray of VectorStore
data[].idstring
data[].object"vector_store"
data[].created_atinteger
data[].namestring
data[].descriptionstring or null
data[].usage_bytesintegerEvery chunk's text and vector, summed over the store's files.
data[].file_countsobject
data[].file_counts.in_progressinteger
data[].file_counts.completedinteger
data[].file_counts.failedinteger
data[].file_counts.cancelledinteger
data[].file_counts.totalinteger
data[].statusstringOne of "expired", "in_progress", "completed".
data[].expires_afterobject or null
data[].expires_after.anchorrequired"last_active_at"
data[].expires_after.daysrequiredintegerFrom 1 to 365.
data[].expires_atinteger or null
data[].last_active_atinteger or null
data[].metadataobject
data[].embedding_modelstringAntimatter's own: the embedding model the store's chunks are embedded with.
data[].embedding_dimensionsinteger or nullAntimatter's own: the vectors' length, null until the first embedding names it.
first_idstring or null
last_idstring or null
has_moreboolean

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 402OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter