Skip to content
API Reference
Vector Stores

Files

List vector store files
vector_stores.files.list(strvector_store_id, FileListParams**kwargs) -> SyncCursorPage[VectorStoreFile]
GET/vector_stores/{vector_store_id}/files
Create vector store file
vector_stores.files.create(strvector_store_id, FileCreateParams**kwargs) -> VectorStoreFile
POST/vector_stores/{vector_store_id}/files
Update vector store file attributes
vector_stores.files.update(strfile_id, FileUpdateParams**kwargs) -> VectorStoreFile
POST/vector_stores/{vector_store_id}/files/{file_id}
Retrieve vector store file
vector_stores.files.retrieve(strfile_id, FileRetrieveParams**kwargs) -> VectorStoreFile
GET/vector_stores/{vector_store_id}/files/{file_id}
Delete vector store file
vector_stores.files.delete(strfile_id, FileDeleteParams**kwargs) -> VectorStoreFileDeleted
DELETE/vector_stores/{vector_store_id}/files/{file_id}
Retrieve vector store file content
vector_stores.files.content(strfile_id, FileContentParams**kwargs) -> SyncPage[FileContentResponse]
GET/vector_stores/{vector_store_id}/files/{file_id}/content
ModelsExpand Collapse
class VectorStoreFile: …

A list of files attached to a vector store.

id: str

The identifier, which can be referenced in API endpoints.

created_at: int

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

last_error: Optional[LastError]

The last error associated with this vector store file. Will be null if there are no errors.

code: Literal["server_error", "unsupported_file", "invalid_file"]

One of server_error, unsupported_file, or invalid_file.

Accepts one of the following:
"server_error"
"unsupported_file"
"invalid_file"
message: str

A human-readable description of the error.

object: Literal["vector_store.file"]

The object type, which is always vector_store.file.

status: Literal["in_progress", "completed", "cancelled", "failed"]

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.

Accepts one of the following:
"in_progress"
"completed"
"cancelled"
"failed"
usage_bytes: int

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

vector_store_id: str

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

attributes: Optional[Dict[str, Union[str, float, bool]]]

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.

Accepts one of the following:
str
float
bool
chunking_strategy: Optional[FileChunkingStrategy]

The strategy used to chunk the file.

class VectorStoreFileDeleted: …
id: str
deleted: bool
object: Literal["vector_store.file.deleted"]