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

client.vectorStores.fileBatches.create(stringvectorStoreID, FileBatchCreateParams { attributes, chunking_strategy, file_ids, files } body, RequestOptionsoptions?): VectorStoreFileBatch { id, created_at, file_counts, 3 more }

POST/vector_stores/{vector_store_id}/file_batches

Retrieve vector store file batch

client.vectorStores.fileBatches.retrieve(stringbatchID, FileBatchRetrieveParams { vector_store_id } params, RequestOptionsoptions?): VectorStoreFileBatch { id, created_at, file_counts, 3 more }

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

Cancel vector store file batch

client.vectorStores.fileBatches.cancel(stringbatchID, FileBatchCancelParams { vector_store_id } params, RequestOptionsoptions?): 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

client.vectorStores.fileBatches.listFiles(stringbatchID, FileBatchListFilesParams { vector_store_id, after, before, 3 more } params, RequestOptionsoptions?): CursorPage<VectorStoreFile { id, created_at, last_error, 6 more } >

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

ModelsExpand Collapse

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: number

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

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

cancelled: number

The number of files that where cancelled.

completed: number

The number of files that have been processed.

failed: number

The number of files that have failed to process.

in_progress: number

The number of files that are currently being processed.

total: number

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.