Folders

Retrieve Folder

get/v1/folders/{folder_id}

Modify Folder

patch/v1/folders/{folder_id}

Delete Folder

delete/v1/folders/{folder_id}

List Folders

get/v1/folders/

Create Folder

post/v1/folders/

ModelsExpand Collapse

Folder = object { id, embedding_config, name, 7 more }

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

id: string

The human-friendly ID of the Source

embedding_config: EmbeddingConfig { embedding_dim, embedding_endpoint_type, embedding_model, 7 more }

The embedding configuration used by the folder.

embedding_dim: number

The dimension of the embedding.

embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 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: string

The model for the embedding.

azure_deployment: optional string

The Azure deployment for the model.

azure_endpoint: optional string

The Azure endpoint for the model.

azure_version: optional string

The Azure version for the model.

batch_size: optional number

The maximum batch size for processing embeddings.

embedding_chunk_size: optional number

The chunk size of the embedding.

embedding_endpoint: optional string

The endpoint for the model (None if local).

handle: optional string

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

name: string

The name of the folder.

created_at: optional string

The timestamp when the folder was created.

formatdate-time

created_by_id: optional string

The id of the user that made this Tool.

description: optional string

The description of the folder.

instructions: optional string

Instructions for how to use the folder.

last_updated_by_id: optional string

The id of the user that made this Tool.

metadata: optional map[unknown]

Metadata associated with the folder.

updated_at: optional string

The timestamp when the folder was last updated.

formatdate-time

FoldersFiles

Upload File To Folder

post/v1/folders/{folder_id}/upload

List Folder Files

get/v1/folders/{folder_id}/files

Delete File From Folder

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

FoldersAgents

List Agents For Folder

get/v1/folders/{folder_id}/agents