Sign in

v2

latestOpenAPI 3.0.0MITraw.githubusercontent.com2024-10-1794217620.9 KB
Vector Stores

Retrieves a vector store file batch.

get/vector_stores/{vector_store_id}/file_batches/{batch_id}

Path parameters

vector_store_idstring required
Example:vs_abc123

The ID of the vector store that the file batch belongs to.

batch_idstring required
Example:vsfb_abc123

The ID of the file batch being retrieved.

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.