Sign in

v44

latestOpenAPI 3.0.0MITraw.githubusercontent.com2024-11-0494279768.0 KB
Vector stores

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[] required

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

Response

OK

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.