API Reference

Vector Stores

File Batches

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve vector store file batch

client.vectorStores.fileBatches.retrieve(stringbatchID, FileBatchRetrieveParams { vector_store_id } params, RequestOptionsoptions?): VectorStoreFileBatch { id, created_at, file_counts, 3 more }

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

Retrieves a vector store file batch.

ParametersExpand Collapse

batchID: string

params: FileBatchRetrieveParams { vector_store_id }

ReturnsExpand Collapse

VectorStoreFileBatch { id, created_at, file_counts, 3 more }

A batch of files attached to a vector store.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

The Unix timestamp (in seconds) for when the vector store files batch was created.

formatunixtime

file_counts: FileCounts { cancelled, completed, failed, 2 more }

object: "vector_store.files_batch"

The object type, which is always vector_store.file_batch.

status: "in_progress" | "completed" | "cancelled" | "failed"

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

vector_store_id: string

The ID of the vector store that the File is attached to.

Retrieve vector store file batch

TypeScript

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

import OpenAI from "openai";
const openai = new OpenAI();

async function main() {
  const vectorStoreFileBatch = await openai.vectorStores.fileBatches.retrieve(
    "vsfb_abc123",
    { vector_store_id: "vs_abc123" }
  );
  console.log(vectorStoreFileBatch);
}

main();

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0,
  }
}

Returns Examples

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0,
  }
}