OpenAI API (unofficial showcase)
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}

Retrieve a vector store file batch

Retrieves a file batch associated with a vector store. Use the batch status and file counts to check the progress and outcome of file processing.

2 parameters
vector_store_idstringrequired
The ID of the vector store that contains the file batch.
batch_idstringrequired
The ID of the file batch to retrieve.

4 status codes
200Returns the file batch object, including its ID, vector store ID, processing status, creation time, and file counts.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always `vector_store.file_batch`.
Allowed:vector_store.file_batch
created_atintegerrequired
The Unix timestamp (in seconds) for when the vector store files batch was created.
vector_store_idstringrequired
The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) that the [File](https://developers.openai.com/api/reference/resources/files) is attached to.
statusstringrequired
The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.
Allowed:in_progresscompletedcancelledfailed
file_countsobjectrequired
400Returned when the file batch identifier is invalid.
errorobjectrequired
404Returned when the vector store or file batch was not found.
errorobjectrequired
429Returned when the request rate limit is exceeded.
errorobjectrequired

Error handling

A 400 is returned when the batch_id path parameter is invalid; a 404 is returned when the vector store or file batch is not found. A 429 is returned when the request rate limit is exceeded. Both vector_store_id and batch_id must identify the store and batch to retrieve.