apicheats.dev openai/llms.txt Raw .md
GET

GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files — OpenAI API

OpenAI API key (required); https://api.openai.com/v1

OpenAI API

List vector store files in a batch

Base URL
https://api.openai.com/v1
Auth
Authorization: Bearer <OPENAI_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 353 tokens · Vary: Accept

Critical gotchas

The Responses API is the primary interface for new text and tool workflows; Chat Completions remains a separate compatibility API.

Audio transcription uploads use multipart form data rather than a JSON request body.

cURL

curl -X GET 'https://api.openai.com/v1/vector_stores/vector-store-id/file_batches/batch-id/files?limit=20&order=desc&after=example-after&before=example-before&filter=in_progress' \  -H "Authorization: Bearer $OPENAI_API_KEY"

Parameters

Name In Type Required Description
vector_store_id path string Yes The ID of the vector store that the files belong to.
batch_id path string Yes The ID of the file batch that the files belong to.
limit query integer No A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
order query string No Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
after query string No 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.
before query string No 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 query string No Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.

Response 200 OK

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "vector_store.file",
      "usage_bytes": 0,
      "created_at": 0,
      "vector_store_id": "string",
      "status": "in_progress",
      "last_error": {
        "code": "server_error",
        "message": "string"
      },
      "chunking_strategy": {
        "type": "static",
        "static": {
          "max_chunk_size_tokens": 0,
          "chunk_overlap_tokens": 0
        }
      },
      "attributes": {}
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc456",
  "has_more": false
}
Get a free OpenAI API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.