Skip to content
API Reference
Vector Stores
File Batches

Cancel vector store file batch

vector_stores.file_batches.cancel(strbatch_id, FileBatchCancelParams**kwargs) -> VectorStoreFileBatch
POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

ParametersExpand Collapse
vector_store_id: str
batch_id: str
ReturnsExpand Collapse
class VectorStoreFileBatch: …

A batch of files attached to a vector store.

id: str

The identifier, which can be referenced in API endpoints.

created_at: int

The Unix timestamp (in seconds) for when the vector store files batch was created.

file_counts: FileCounts
cancelled: int

The number of files that where cancelled.

completed: int

The number of files that have been processed.

failed: int

The number of files that have failed to process.

in_progress: int

The number of files that are currently being processed.

total: int

The total number of files.

object: Literal["vector_store.files_batch"]

The object type, which is always vector_store.file_batch.

status: Literal["in_progress", "completed", "cancelled", "failed"]

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

Accepts one of the following:
"in_progress"
"completed"
"cancelled"
"failed"
vector_store_id: str

The ID of the vector store that the File is attached to.

Cancel vector store file batch

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
vector_store_file_batch = client.vector_stores.file_batches.cancel(
    batch_id="batch_id",
    vector_store_id="vector_store_id",
)
print(vector_store_file_batch.id)
{
  "id": "id",
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "object": "vector_store.files_batch",
  "status": "in_progress",
  "vector_store_id": "vector_store_id"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "object": "vector_store.files_batch",
  "status": "in_progress",
  "vector_store_id": "vector_store_id"
}