Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
POST
/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
Authorizations
Parameters
Path Parameters
vector_store_id
required
string
The ID of the vector store that the file batch belongs to.
batch_id
required
string
The ID of the file batch to cancel.
Responses
200
OK
A batch of files attached to a vector store.
object
id
required
The identifier, which can be referenced in API endpoints.
string
object
required
The object type, which is always vector_store.file_batch.
string
created_at
required
The Unix timestamp (in seconds) for when the vector store files batch was created.
integer
vector_store_id
required
The ID of the vector store that the File is attached to.
string
status
required
The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.
string
file_counts
required
object
in_progress
required
The number of files that are currently being processed.
integer
completed
required
The number of files that have been processed.
integer
failed
required
The number of files that have failed to process.
integer
cancelled
required
The number of files that where cancelled.
integer
total
required
The total number of files.
integer