API reference

API reference · Account

The signed in account's vector stores, for the dashboard

GET/api/account/vector-storesSigned in session

Answer 200

The personal account's stores.

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

Errors

  • 401OpenAI shaped error.
  • 404OpenAI 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