API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Folders

Retrieve Folder

folders.retrieve(strfolder_id) -> Folder

get/v1/folders/{folder_id}

Modify Folder

folders.modify(strfolder_id, FolderModifyParams**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.

Accepts 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 Folder Files

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

get/v1/folders/{folder_id}/files

Delete File From Folder

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

delete/v1/folders/{folder_id}/{file_id}

FoldersAgents

List Agents For Folder

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

get/v1/folders/{folder_id}/agents