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

List files in a vector store batch

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

7 parameters
vector_store_idstringrequired
The ID of the vector store that contains the files.
batch_idstringrequired
The ID of the file batch that contains the files.
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 identifying the last object on the previous page; use it to fetch the next page.
beforestringoptional
Cursor identifying the first object on the current page; use it to fetch the previous page.
filterstringoptional
Filter files by status: `in_progress`, `completed`, `failed`, or `cancelled`.
Allowed:in_progresscompletedfailedcancelled

4 status codes
200Returns a page of vector store file objects with file status, usage, creation time, and cursor IDs indicating whether more results are available.
objectstringrequired
dataarray<VectorStoreFiles>required
first_idstringrequired
last_idstringrequired
has_morebooleanrequired
400Returned when the file batch identifier or file status filter 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 or filter is invalid; a 404 is returned when the vector_store_id path parameter or file batch is not found. A 429 is returned when the request rate limit is exceeded. limit must be between 1 and 100, and filter must be one of in_progress, completed, failed, or cancelled.