API Reference

Folders

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Files

Upload File To Folder

folders.files.upload(strfolder_id, FileUploadParams**kwargs) -> FileUploadResponse

POST/v1/folders/{folder_id}/upload

List Files For Folder

folders.files.list(strfolder_id, FileListParams**kwargs) -> SyncArrayPage[FileListResponse]

GET/v1/folders/{folder_id}/files

Retrieve File

folders.files.retrieve(strfile_id, FileRetrieveParams**kwargs) -> FileRetrieveResponse

GET/v1/folders/{folder_id}/files/{file_id}

Delete File From Folder

folders.files.delete(strfile_id, FileDeleteParams**kwargs)

DELETE/v1/folders/{folder_id}/{file_id}

ModelsExpand Collapse

class FileUploadResponse: …

Representation of a single FileMetadata

id: str

The human-friendly ID of the File

Deprecatedsource_id: str

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: Optional[int]

Number of chunks that have been embedded.

content: Optional[str]

Optional full-text content of the file; only populated on demand due to its size.

created_at: Optional[datetime]

The creation date of the file.

formatdate-time

error_message: Optional[str]

Optional error message if the file failed processing.

file_creation_date: Optional[str]

The creation date of the file.

file_last_modified_date: Optional[str]

The last modified date of the file.

file_name: Optional[str]

The name of the file.

file_path: Optional[str]

The path to the file.

file_size: Optional[int]

The size of the file in bytes.

file_type: Optional[str]

The type of the file (MIME type).

original_file_name: Optional[str]

The original name of the file as uploaded.

processing_status: Optional[Literal["pending", "parsing", "embedding", 2 more]]

The current processing status of the file (e.g. pending, parsing, embedding, completed, error).

One of the following:

"pending"

"parsing"

"embedding"

"completed"

"error"

total_chunks: Optional[int]

Total number of chunks for the file.

updated_at: Optional[datetime]

The update date of the file.

formatdate-time

class FileListResponse: …

Representation of a single FileMetadata

id: str

The human-friendly ID of the File

Deprecatedsource_id: str

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: Optional[int]

Number of chunks that have been embedded.

content: Optional[str]

Optional full-text content of the file; only populated on demand due to its size.

created_at: Optional[datetime]

The creation date of the file.

formatdate-time

error_message: Optional[str]

Optional error message if the file failed processing.

file_creation_date: Optional[str]

The creation date of the file.

file_last_modified_date: Optional[str]

The last modified date of the file.

file_name: Optional[str]

The name of the file.

file_path: Optional[str]

The path to the file.

file_size: Optional[int]

The size of the file in bytes.

file_type: Optional[str]

The type of the file (MIME type).

original_file_name: Optional[str]

The original name of the file as uploaded.

processing_status: Optional[Literal["pending", "parsing", "embedding", 2 more]]

The current processing status of the file (e.g. pending, parsing, embedding, completed, error).

One of the following:

"pending"

"parsing"

"embedding"

"completed"

"error"

total_chunks: Optional[int]

Total number of chunks for the file.

updated_at: Optional[datetime]

The update date of the file.

formatdate-time

class FileRetrieveResponse: …

Representation of a single FileMetadata

id: str

The human-friendly ID of the File

Deprecatedsource_id: str

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: Optional[int]

Number of chunks that have been embedded.

content: Optional[str]

Optional full-text content of the file; only populated on demand due to its size.

created_at: Optional[datetime]

The creation date of the file.

formatdate-time

error_message: Optional[str]

Optional error message if the file failed processing.

file_creation_date: Optional[str]

The creation date of the file.

file_last_modified_date: Optional[str]

The last modified date of the file.

file_name: Optional[str]

The name of the file.

file_path: Optional[str]

The path to the file.

file_size: Optional[int]

The size of the file in bytes.

file_type: Optional[str]

The type of the file (MIME type).

original_file_name: Optional[str]

The original name of the file as uploaded.

processing_status: Optional[Literal["pending", "parsing", "embedding", 2 more]]

The current processing status of the file (e.g. pending, parsing, embedding, completed, error).

One of the following:

"pending"

"parsing"

"embedding"

"completed"

"error"

total_chunks: Optional[int]

Total number of chunks for the file.

updated_at: Optional[datetime]

The update date of the file.

formatdate-time