API reference · API
Create a vector store (OpenAI wire format)
POST/v1/vector_storesAPI key
A store on the key's account (the embeddings scope). Given file_ids, each file is read, chunked and embedded after the answer, as this key, every embedding an embeddings request held and billed like /v1/embeddings.
Request body
application/json, optional
| Field | Type | What it is |
|---|---|---|
| name | string or null | |
| description | string or null | |
| metadata | object or null | At most 16 pairs of strings. |
| expires_after | object or null | |
| expires_after. | "last_active_at" | |
| expires_after. | integer | From 1 to 365. |
| file_ids | array of string | |
| chunking_strategy | object | auto is 800 tokens overlapping by 400; static takes 100 to 4096 tokens and an overlap of at most half of that. |
| embedding_model | string | Antimatter's own: an id from GET /v1/embeddings/models. The deployment's default (ANTIMATTER_VECTOR_EMBEDDING_MODEL) when absent. |
| embedding_dimensions | integer | Antimatter's own: asked of a model that takes a dimensions parameter (text-embedding-3), or the length another model gives; learned from the first embedding when absent. One of 256, 384, 512, 768, 1024, 1536, 2048, 2560, 3072, 4096. |
Example
{}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.
- 503OpenAI 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.