Sign in

v2

latestOpenAPI 3.0.0MITraw.githubusercontent.com2024-10-1794217620.9 KB
Vector Stores

Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).

post/vector_stores/{vector_store_id}/files

Path parameters

vector_store_idstring required
Example:vs_abc123

The ID of the vector store for which to create a File.

Request body

file_idstring required

A File ID that the vector store should use. Useful for tools like file_search that can access files.

Response

OK

idstring required

The identifier, which can be referenced in API endpoints.

object'vector_store.file' required

The object type, which is always vector_store.file.

usage_bytesinteger required

The total vector store usage in bytes. Note that this may be different from the original file size.

created_atinteger required

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

vector_store_idstring required

The ID of the vector store that the File is attached to.

status'in_progress' | 'completed' | 'cancelled' | 'failed' required

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