API reference · API
Retrieve a vector store
GET/v1/vector_stores/{id}API key
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The vector store id, vs_ and 24 hex digits. |
Answer 200
The store.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| object | "vector_store" | |
| created_at | integer | |
| name | string | |
| description | string or null | |
| usage_bytes | integer | Every chunk's text and vector, summed over the store's files. |
| file_counts | object | |
| file_counts. | integer | |
| file_counts. | integer | |
| file_counts. | integer | |
| file_counts. | integer | |
| file_counts. | integer | |
| status | string | One of "expired", "in_progress", "completed". |
| expires_after | object or null | |
| expires_after. | "last_active_at" | |
| expires_after. | integer | From 1 to 365. |
| expires_at | integer or null | |
| last_active_at | integer or null | |
| metadata | object | |
| embedding_model | string | Antimatter's own: the embedding model the store's chunks are embedded with. |
| embedding_dimensions | integer or null | Antimatter's own: the vectors' length, null until the first embedding names it. |
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.