Sign in

Creates a vector store.

post/vector_stores

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

file_idsstring[]

A list of file IDs that the vector store should use. Useful for tools like file_search that can access files.

namestring

The name of the vector store.

metadataobject nullable

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

Response

The request has succeeded.

idstring required

The identifier, which can be referenced in API endpoints.

object'vector_store' required

The object type, which is always vector_store

created_atinteger required

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

namestring required

The name of the vector store.

usage_bytesinteger required

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

status'expired' | 'in_progress' | 'completed' required

Vector store possible status

expires_atinteger nullable

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

last_active_atinteger nullable required

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

metadataobject nullable required

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

Changes

No recorded changes to this endpoint across all 12 revisions of this API.