Sign in

v6

latestSwagger 2.02026-07-1340109191.2 KB

Create a vector store file batch.

post/vector_stores/{vectorStoreId}/file_batches

Path parameters

vectorStoreIdstring required

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

Request body

file_idsstring[] required

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

Response

The request has succeeded.

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 file batch.