API Reference

Vector Stores

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

File Batches

Create vector store file batch

vector_stores.file_batches.create(vector_store_id, **kwargs) -> VectorStoreFileBatch { id, created_at, file_counts, 3 more }

POST/vector_stores/{vector_store_id}/file_batches

Retrieve vector store file batch

vector_stores.file_batches.retrieve(batch_id, **kwargs) -> VectorStoreFileBatch { id, created_at, file_counts, 3 more }

GET/vector_stores/{vector_store_id}/file_batches/{batch_id}

Cancel vector store file batch

vector_stores.file_batches.cancel(batch_id, **kwargs) -> VectorStoreFileBatch { id, created_at, file_counts, 3 more }

POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

List vector store files in a batch

vector_stores.file_batches.list_files(batch_id, **kwargs) -> CursorPage<VectorStoreFile { id, created_at, last_error, 6 more } >

GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

ModelsExpand Collapse

class VectorStoreFileBatch { id, created_at, file_counts, 3 more }

A batch of files attached to a vector store.

id: String

The identifier, which can be referenced in API endpoints.

created_at: Integer

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

file_counts: { cancelled, completed, failed, 2 more}

cancelled: Integer

The number of files that where cancelled.

completed: Integer

The number of files that have been processed.

failed: Integer

The number of files that have failed to process.

in_progress: Integer

The number of files that are currently being processed.

total: Integer

The total number of files.

object: :"vector_store.files_batch"

The object type, which is always vector_store.file_batch.

status: :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: String

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