Sample - OpenAI API
GET/vector_stores/{vector_store_id}

Retrieve a vector store

Retrieves a vector store by its identifier. Use this endpoint to inspect its processing status, file counts, usage, expiration details, and metadata.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
vector_store_idstringrequired
The identifier of the vector store to retrieve.

2 status codes
200Returns the vector store identified by `vector_store_id`, including its status, usage, file counts, timestamps, expiration details, and metadata.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always `vector_store`.
Allowed:vector_store
created_atintegerrequired
The Unix timestamp (in seconds) for when the vector store was created.
namestringrequired
The name of the vector store.
usage_bytesintegerrequired
The total number of bytes used by the files in the vector store.
file_countsobjectrequired
statusstringrequired
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.
Allowed:expiredin_progresscompleted
expires_afterobjectoptional
The expiration policy for a vector store.
expires_atintegeroptional
The Unix timestamp (in seconds) for when the vector store will expire.
last_active_atintegerrequired
The Unix timestamp (in seconds) for when the vector store was last active.
metadataobjectrequired
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.
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

vector_store_id must identify the vector store you want to retrieve. A 429 is returned when the request exceeds the applicable rate limit.