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

FileListPage vectorStores().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/vector_stores/{vector_store_id}/files

Create vector store file

VectorStoreFile vectorStores().files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}/files

Update vector store file attributes

VectorStoreFile vectorStores().files().update(FileUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Retrieve vector store file

VectorStoreFile vectorStores().files().retrieve(FileRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Delete vector store file

VectorStoreFileDeleted vectorStores().files().delete(FileDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Retrieve vector store file content

FileContentPage vectorStores().files().content(FileContentParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

ModelsExpand Collapse

class VectorStoreFile:

A list of files attached to a vector store.

String id

The identifier, which can be referenced in API endpoints.

long createdAt

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

Optional<LastError> lastError

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

Code code

One of server_error, unsupported_file, or invalid_file.

Accepts one of the following:

SERVER_ERROR("server_error")

UNSUPPORTED_FILE("unsupported_file")

INVALID_FILE("invalid_file")

String message

A human-readable description of the error.

JsonValue; object_ "vector_store.file"constant"vector_store.file"constant

The object type, which is always vector_store.file.

Status status

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("in_progress")

COMPLETED("completed")

CANCELLED("cancelled")

FAILED("failed")

long usageBytes

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

String vectorStoreId

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

Optional<Attributes> attributes

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

double

boolean

Optional<FileChunkingStrategy> chunkingStrategy

The strategy used to chunk the file.

class VectorStoreFileDeleted:

String id

boolean deleted

JsonValue; object_ "vector_store.file.deleted"constant"vector_store.file.deleted"constant