Sample - OpenAI API
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 this endpoint to inspect the batch's processing status and counts for files in progress, completed, failed, or cancelled.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

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

2 status codes
200Returns the vector store file batch, including its identifier, creation timestamp, parent vector store ID, status, 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.files_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
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

vector_store_id must identify the parent vector store, and batch_id must identify the file batch to retrieve. A 429 is returned when the request exceeds the applicable rate limit.