API reference · API
Cancel a file batch
POST/v1/vector_stores/{id}/file_batches/{batchId}/cancelAPI key
Files still being read are cancelled; what was embedded before stays billed.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The vector store id, vs_ and 24 hex digits. |
| batchId (path)required | string | The file batch id, vsfb_ and 24 hex digits. |
Answer 200
The batch.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| object | "vector_store.file_batch" | |
| created_at | integer | |
| vector_store_id | string | |
| status | string | One of "in_progress", "completed", "cancelled", "failed". |
| file_counts | object | |
| file_counts. | integer | |
| file_counts. | integer | |
| file_counts. | integer | |
| file_counts. | integer | |
| file_counts. | integer |
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.