Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Vector Stores
File Batches

Retrieve vector store file batch

$ openai vector-stores:file-batches retrieve
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}

Retrieves a vector store file batch.

ParametersExpand Collapse
--vector-store-id: string

The ID of the vector store that the file batch belongs to.

--batch-id: string

The ID of the file batch being retrieved.

ReturnsExpand Collapse
vector_store_file_batch: object { 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.

file_counts: object { cancelled, completed, failed, 2 more }
cancelled: number

The number of files that where cancelled.

completed: number

The number of files that have been processed.

failed: number

The number of files that have failed to process.

in_progress: number

The number of files that are currently being processed.

total: number

The total number of files.

object: "vector_store.files_batch"

The object type, which is always vector_store.file_batch.

status: "in_progress" or "completed" or "cancelled" or "failed"

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

"in_progress"
"completed"
"cancelled"
"failed"
vector_store_id: string

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

Retrieve vector store file batch

openai vector-stores:file-batches retrieve \
  --api-key 'My API Key' \
  --vector-store-id vs_abc123 \
  --batch-id vsfb_abc123
{
  "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,
  }
}