Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132429592.7 MB
Vector stores

Update attributes on a vector store file.

post/vector_stores/{vector_store_id}/files/{file_id}

Path parameters

vector_store_idstring required
Example:vs_abc123

The ID of the vector store the file belongs to.

file_idstring required
Example:file-abc123

The ID of the file to update attributes.

Request body

attributesVectorStoreFileAttributes nullable required

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, booleans, or numbers.

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.

attributesVectorStoreFileAttributes nullable

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, booleans, or numbers.