Create a vector store.
POST /vector_stores
Authorizations
Request Body required
object
A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.
The name of the vector store.
The expiration policy for a vector store.
object
Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.
The number of days after the anchor time that the vector store will expire.
The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
object
Always auto.
object
Always static.
object
The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.
The number of tokens that overlap between chunks. The default value is 400.
Note that the overlap must not exceed half of max_chunk_size_tokens.
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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
object
Responses
200
OK
A vector store is a collection of processed files can be used by the file_search tool.
object
The identifier, which can be referenced in API endpoints.
The object type, which is always vector_store.
The Unix timestamp (in seconds) for when the vector store was created.
The name of the vector store.
The total number of bytes used by the files in the vector store.
object
The number of files that are currently being processed.
The number of files that have been successfully processed.
The number of files that have failed to process.
The number of files that were cancelled.
The total number of files.
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.
The expiration policy for a vector store.
object
Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.
The number of days after the anchor time that the vector store will expire.
The Unix timestamp (in seconds) for when the vector store will expire.
The Unix timestamp (in seconds) for when the vector store was last active.
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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.