API Reference

Vector Stores

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Files

List vector store files

client.vectorStores.files.list(stringvectorStoreID, FileListParams { after, before, filter, 2 more } query?, RequestOptionsoptions?): CursorPage<VectorStoreFile { id, created_at, last_error, 6 more } >

GET/vector_stores/{vector_store_id}/files

Create vector store file

client.vectorStores.files.create(stringvectorStoreID, FileCreateParams { file_id, attributes, chunking_strategy } body, RequestOptionsoptions?): VectorStoreFile { id, created_at, last_error, 6 more }

POST/vector_stores/{vector_store_id}/files

Update vector store file attributes

client.vectorStores.files.update(stringfileID, FileUpdateParams { vector_store_id, attributes } params, RequestOptionsoptions?): VectorStoreFile { id, created_at, last_error, 6 more }

POST/vector_stores/{vector_store_id}/files/{file_id}

Retrieve vector store file

client.vectorStores.files.retrieve(stringfileID, FileRetrieveParams { vector_store_id } params, RequestOptionsoptions?): VectorStoreFile { id, created_at, last_error, 6 more }

GET/vector_stores/{vector_store_id}/files/{file_id}

Delete vector store file

client.vectorStores.files.delete(stringfileID, FileDeleteParams { vector_store_id } params, RequestOptionsoptions?): VectorStoreFileDeleted { id, deleted, object }

DELETE/vector_stores/{vector_store_id}/files/{file_id}

Retrieve vector store file content

client.vectorStores.files.content(stringfileID, FileContentParams { vector_store_id } params, RequestOptionsoptions?): Page<FileContentResponse { text, type } >

GET/vector_stores/{vector_store_id}/files/{file_id}/content

ModelsExpand Collapse

VectorStoreFile { id, created_at, last_error, 6 more }

A list of files attached to a vector store.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

last_error: LastError | null

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

code: "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: string

A human-readable description of the error.

object: "vector_store.file"

The object type, which is always vector_store.file.

status: "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: number

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

vector_store_id: string

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

attributes?: Record<string, string | number | boolean> | null

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:

string

number

boolean

chunking_strategy?: FileChunkingStrategy

The strategy used to chunk the file.

VectorStoreFileDeleted { id, deleted, object }

id: string

deleted: boolean

object: "vector_store.file.deleted"