API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Folders

Retrieve Folder

client.folders.retrieve(stringfolderID, RequestOptionsoptions?): Folder { id, embedding_config, name, 7 more }

get/v1/folders/{folder_id}

Modify Folder

client.folders.modify(stringfolderID, FolderModifyParams { description, embedding_config, instructions, 2 more } body, RequestOptionsoptions?): Folder { id, embedding_config, name, 7 more }

patch/v1/folders/{folder_id}

Delete Folder

client.folders.delete(stringfolderID, RequestOptionsoptions?): FolderDeleteResponse

delete/v1/folders/{folder_id}

List Folders

client.folders.list(FolderListParams { after, before, limit, 3 more } query?, RequestOptionsoptions?): ArrayPage<Folder { id, embedding_config, name, 7 more } >

get/v1/folders/

Create Folder

client.folders.create(FolderCreateParams { name, description, embedding, 4 more } body, RequestOptionsoptions?): Folder { id, embedding_config, name, 7 more }

post/v1/folders/

ModelsExpand Collapse

Folder { 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" | "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: 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 folder.

created_at?: string | null

The timestamp when the folder 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 folder.

instructions?: string | null

Instructions for how to use the folder.

last_updated_by_id?: string | null

The id of the user that made this Tool.

metadata?: Record<string, unknown> | null

Metadata associated with the folder.

updated_at?: string | null

The timestamp when the folder was last updated.

formatdate-time

FoldersFiles

Upload File To Folder

client.folders.files.upload(stringfolderID, FileUploadParams { file, duplicate_handling, name } params, RequestOptionsoptions?): FileUploadResponse { id, source_id, chunks_embedded, 13 more }

post/v1/folders/{folder_id}/upload

List Folder Files

client.folders.files.list(stringfolderID, FileListParams { after, before, include_content, 3 more } query?, RequestOptionsoptions?): ArrayPage<FileListResponse { id, source_id, chunks_embedded, 13 more } >

get/v1/folders/{folder_id}/files

Delete File From Folder

client.folders.files.delete(stringfileID, FileDeleteParams { folder_id } params, RequestOptionsoptions?): void

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

FoldersAgents

List Agents For Folder

client.folders.agents.list(stringfolderID, AgentListParams { after, before, limit, 2 more } query?, RequestOptionsoptions?): AgentListResponse

get/v1/folders/{folder_id}/agents