Sample - OpenAI API
POST/vector_stores/{vector_store_id}

Modify a vector store

Updates the configurable properties of an existing vector store. Supply only the properties you want to change, such as name, expires_after, or metadata.

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

1 parameter · 3 body fields
vector_store_idstringrequired
The identifier of the vector store to modify.

Properties to update on the vector store; omitted properties retain their existing values.

namestringoptional
The name of the vector store.
expires_afterobjectoptional
The replacement expiration policy, including its required anchor and days values.
metadataobjectoptional
Replacement metadata for the vector store, using string values or null to clear metadata.

2 status codes
200Returns the updated vector store, including its identifier, status, usage, file counts, 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

If provided, expires_after must include its required anchor and days values. metadata must contain string values when supplied, and a 429 is returned when the request exceeds the applicable rate limit.