API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Folders

Retrieve Folder

folders.retrieve(strfolder_id) -> Folder

GET/v1/folders/{folder_id}

Update Folder

folders.update(strfolder_id, FolderUpdateParams**kwargs) -> Folder

PATCH/v1/folders/{folder_id}

Delete Folder

folders.delete(strfolder_id) -> object

DELETE/v1/folders/{folder_id}

List Folders

folders.list(FolderListParams**kwargs) -> SyncArrayPage[Folder]

GET/v1/folders/

Create Folder

folders.create(FolderCreateParams**kwargs) -> Folder

POST/v1/folders/

ModelsExpand Collapse

class Folder: …

Representation of a folder, which is a collection of files and passages.

id: str

The human-friendly ID of the Source

embedding_config: EmbeddingConfig

The embedding configuration used by the folder.

embedding_dim: int

The dimension of the embedding.

embedding_endpoint_type: Literal["openai", "anthropic", "bedrock", 16 more]

The endpoint type for the model.

One of the following:

"openai"

"anthropic"

"bedrock"

"google_ai"

"google_vertex"

"azure"

"groq"

"ollama"

"webui"

"webui-legacy"

"lmstudio"

"lmstudio-legacy"

"llamacpp"

"koboldcpp"

"vllm"

"hugging-face"

"mistral"

"together"

"pinecone"

embedding_model: str

The model for the embedding.

azure_deployment: Optional[str]

The Azure deployment for the model.

azure_endpoint: Optional[str]

The Azure endpoint for the model.

azure_version: Optional[str]

The Azure version for the model.

batch_size: Optional[int]

The maximum batch size for processing embeddings.

embedding_chunk_size: Optional[int]

The chunk size of the embedding.

embedding_endpoint: Optional[str]

The endpoint for the model (None if local).

handle: Optional[str]

The handle for this config, in the format provider/model-name.

name: str

The name of the folder.

created_at: Optional[datetime]

The timestamp when the folder was created.

formatdate-time

created_by_id: Optional[str]

The id of the user that made this Tool.

description: Optional[str]

The description of the folder.

instructions: Optional[str]

Instructions for how to use the folder.

last_updated_by_id: Optional[str]

The id of the user that made this Tool.

metadata: Optional[Dict[str, object]]

Metadata associated with the folder.

updated_at: Optional[datetime]

The timestamp when the folder was last updated.

formatdate-time

FoldersFiles

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

FoldersAgents

List Agents For Folder

folders.agents.list(strfolder_id, AgentListParams**kwargs) -> AgentListResponse

GET/v1/folders/{folder_id}/agents

ModelsExpand Collapse

List[str]