Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Retrieve vector store

$ openai vector-stores retrieve
GET/vector_stores/{vector_store_id}

Retrieves a vector store.

ParametersExpand Collapse
--vector-store-id: string

The ID of the vector store to retrieve.

ReturnsExpand Collapse
vector_store: object { id, created_at, file_counts, 8 more }

A vector store is a collection of processed files can be used by the file_search tool.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

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

The Unix timestamp (in seconds) for when the vector store was last active.

metadata: map[string]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

name: string

The name of the vector store.

object: "vector_store"

The object type, which is always vector_store.

status: "expired" or "in_progress" or "completed"

The status of the vector store, which can be either expired, in_progress, or completed. A status of completed indicates that the vector store is ready for use.

usage_bytes: number

The total number of bytes used by the files in the vector store.

expires_after: optional object { anchor, days }

The expiration policy for a vector store.

expires_at: optional number

The Unix timestamp (in seconds) for when the vector store will expire.

Retrieve vector store

openai vector-stores retrieve \
  --api-key 'My API Key' \
  --vector-store-id vector_store_id
{
  "id": "vs_abc123",
  "object": "vector_store",
  "created_at": 1699061776,
  "name": "Support FAQ",
  "file_counts": {
    "in_progress": 0,
    "completed": 3,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  },
  "usage_bytes": 139920,
  "status": "completed",
  "last_active_at": null,
  "metadata": {}
}
Returns Examples
{
  "id": "vs_abc123",
  "object": "vector_store",
  "created_at": 1699061776,
  "name": "Support FAQ",
  "file_counts": {
    "in_progress": 0,
    "completed": 3,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  },
  "usage_bytes": 139920,
  "status": "completed",
  "last_active_at": null,
  "metadata": {}
}