POST
/
vector_stores
/
{vector_store_id}
/
file_batches
/
{batch_id}
/
cancel
curl --request POST \
  --url https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "vector_store.files_batch",
  "created_at": 123,
  "vector_store_id": "<string>",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 123,
    "completed": 123,
    "failed": 123,
    "cancelled": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vector_store_id
string
required

The ID of the vector store that the file batch belongs to.

​
batch_id
string
required

The ID of the file batch to cancel.

Response

200 - application/json

OK

A batch of files attached to a vector store.