Sample - OpenAI API
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

List files in a vector store batch

Lists the files in a specific vector store file batch. Use filter to restrict results by processing status and cursor parameters to navigate through the batch's files.

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

7 parameters
vector_store_idstringrequired
The identifier of the vector store that contains the files.
batch_idstringrequired
The identifier of the file batch whose files to list.
limitintegeroptional
Maximum number of files to return, from 1 to 100. Defaults to 20 when omitted.
Default:20
orderstringoptional
Sort order by creation time: `asc` or `desc`. Defaults to `desc` when omitted.
Allowed:ascdescDefault:desc
afterstringoptional
Cursor object ID after which to return the next page of files.
beforestringoptional
Cursor object ID before which to return the previous page of files.
filterstringoptional
Filter files by status: `in_progress`, `completed`, `failed`, or `cancelled.
Allowed:in_progresscompletedfailedcancelled

2 status codes
200Returns a paginated collection of vector store file objects, including file status details, the first and last object IDs, and a `has_more` indicator.
objectstringrequired
dataarray<VectorStoreFiles>required
first_idstringrequired
last_idstringrequired
has_morebooleanrequired
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

filter must be one of in_progress, completed, failed, or cancelled when supplied. limit must be between 1 and 100, and a 429 is returned when the request exceeds the applicable rate limit.