Returns a list of vector store files in a batch.

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

Returns a list of vector store files in a batch.

cURL

curl --request GET \
  --url https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "vector_store.file",
      "usage_bytes": 123,
      "created_at": 123,
      "vector_store_id": "<string>",
      "last_error": {
        "message": "<string>"
      },
      "chunking_strategy": {
        "type": "static",
        "static": {
          "max_chunk_size_tokens": 2098,
          "chunk_overlap_tokens": 123
        }
      },
      "attributes": {}
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc456",
  "has_more": false
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vector_store_id · string · required

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

batch_id · string · required

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

Query Parameters

limit · integer · default: 20

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

order · enum<string> · default: desc

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

Available options: asc, desc

after · string

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 · string

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 · enum<string>

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

Available options: in_progress, completed, failed, cancelled

Response

200 - application/json

OK

object · string · required

Example:

"list"

data · Vector store files · object[] · required

Show child attributes

first_id · string · required

Example:

"file-abc123"

last_id · string · required

Example:

"file-abc456"

has_more · boolean · required

Example:

false