API reference · API
Attach a file to a vector store
POST/v1/vector_stores/{id}/filesAPI key
The file is in_progress until it is read, chunked and embedded, as this key, on its account; a file already in the store is answered as it is.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The vector store id, vs_ and 24 hex digits. |
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| file_idrequired | string | A file uploaded with purpose assistants. |
| attributes | object or null | At most 16 pairs; keys up to 64 characters, values a string up to 512 characters, a number or a boolean. |
| 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. |
Example
{
"file_id": "string",
"attributes": {},
"chunking_strategy": {
"type": "auto"
}
}Answer 200
The file in the store.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| object | "vector_store.file" | |
| created_at | integer | |
| vector_store_id | string | |
| status | string | One of "in_progress", "completed", "failed", "cancelled". |
| usage_bytes | integer | |
| last_error | object or null | |
| last_error. | string | One of "server_error", "unsupported_file", "invalid_file". |
| last_error. | string | |
| attributes | object or null | At most 16 pairs; keys up to 64 characters, values a string up to 512 characters, a number or a boolean. |
| 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. |
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.