v32

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-312881,4162.7 MB

Vector stores

Create vector store file batch

Create a vector store file batch.

post/vector_stores/{vector_store_id}/file_batches

Path parameters

vector_store_idstring required

Example:vs_abc123

The ID of the vector store for which to create a File Batch.

Request body

file_idsstring[]

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files. If attributes or chunking_strategy are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with files.

attributesVectorStoreFileAttributes nullable

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Response

idstring required

The identifier, which can be referenced in API endpoints.

object'vector_store.files_batch' required

The object type, which is always vector_store.file_batch.

created_atinteger required

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

vector_store_idstring required

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

status'in_progress' | 'completed' | 'cancelled' | 'failed' required

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