Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

File Batches

Cancel vector store file batch
POST
/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
Create vector store file batch
POST
/vector_stores/{vector_store_id}/file_batches
List vector store files in a batch
GET
/vector_stores/{vector_store_id}/file_batches/{batch_id}/files
Retrieve vector store file batch
GET
/vector_stores/{vector_store_id}/file_batches/{batch_id}
Models
VectorStoreFileBatch object { 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.

formatunixtime
file_counts: object { 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.file_batch"

The object type, which is always vector_store.file_batch.

status: "in_progress" or "completed" or "cancelled" or "failed"

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

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.