Retrieve vector store file batch

GEThttps:/api.openai.com/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}

Retrieves a vector store file batch.

Path parameters

  • vector_store_id
    string
    Required
    The ID of the vector store that the file batch belongs to.
  • batch_id
    string
    Required
    The ID of the file batch being retrieved.

Response

Example request
1
curl https://api.openai.com/v1/vector_stores/vs_abc123/files_batches/vsfb_abc123 \

2
  -H "Authorization: Bearer $OPENAI_API_KEY" \

3
  -H "Content-Type: application/json" \

4
  -H "OpenAI-Beta: assistants=v2"
Example response
1
{

2
  "id": "vsfb_abc123",

3
  "object": "vector_store.file_batch",

4
  "created_at": 1699061776,

5
  "vector_store_id": "vs_abc123",

6
  "status": "in_progress",

7
  "file_counts": {

8
    "in_progress": 1,

9
    "completed": 1,

10
    "failed": 0,

11
    "cancelled": 0,

12
    "total": 0,

13
  }

14
}
Built with