Folders

Attach Folder To Agent

client.agents.folders.attach(, , ?): AgentState { id, agent_type, blocks, 42 more } | null

PATCH/v1/agents/{agent_id}/folders/attach/{folder_id}

Detach Folder From Agent

client.agents.folders.detach(, , ?): AgentState { id, agent_type, blocks, 42 more } | null

PATCH/v1/agents/{agent_id}/folders/detach/{folder_id}

List Folders For Agent

client.agents.folders.list(, ?, ?): ArrayPage<FolderListResponse { id, embedding_config, name, 8 more } >

GET/v1/agents/{agent_id}/folders

ModelsExpand Collapse

FolderListResponse { id, embedding_config, name, 8 more }

(Deprecated: Use Folder) Representation of a source, 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 source.

embedding_dim: number

The dimension of the embedding.

embedding_endpoint_type: "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: string

The model for the embedding.

azure_deployment?: string | null

The Azure deployment for the model.

azure_endpoint?: string | null

The Azure endpoint for the model.

azure_version?: string | null

The Azure version for the model.

batch_size?: number

The maximum batch size for processing embeddings.

embedding_chunk_size?: number | null

The chunk size of the embedding.

embedding_endpoint?: string | null

The endpoint for the model (None if local).

handle?: string | null

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

name: string

The name of the source.

created_at?: string | null

The timestamp when the source was created.

formatdate-time

created_by_id?: string | null

The id of the user that made this Tool.

description?: string | null

The description of the source.

instructions?: string | null

Instructions for how to use the source.

last_updated_by_id?: string | null

The id of the user that made this Tool.

metadata?: Record<string, unknown> | null

Metadata associated with the source.

updated_at?: string | null

The timestamp when the source was last updated.

formatdate-time

vector_db_provider?: VectorDBProvider

The vector database provider used for this source’s passages

One of the following:

"native"

"tpuf"

"pinecone"