provider Vector stores GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files
@utdk/openai /vector_stores/{vector_store_id}/file_batches/{batch_id}/files
Returns a list of vector store files in a batch.
vector_store_id path required
The ID of the vector store that the files belong to.
string
batch_id path required
The ID of the file batch that the files belong to.
string
limit query
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
integer
order query
Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
enum: asc, desc
after query
A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
string
before query
A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
string
filter query
Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
enum: in_progress, completed, failed, cancelled

Try it

Authentication
Configure credentials for OpenAI API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

listfilesinvectorstorebatch
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Parameters

required

The ID of the vector store that the files belong to.

required

The ID of the file batch that the files belong to.

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import openai from '@utdk/openai';

await openai.listfilesinvectorstorebatch({
  "limit": 20,
  "order": "desc"
})