Folders

Retrieve Folder

GET/v1/folders/{folder_id}

Update 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.

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

FolderDeleteResponse = unknown

FoldersFiles

Upload File To Folder

POST/v1/folders/{folder_id}/upload

List Files For Folder

GET/v1/folders/{folder_id}/files

Retrieve File

GET/v1/folders/{folder_id}/files/{file_id}

Delete File From Folder

DELETE/v1/folders/{folder_id}/{file_id}

ModelsExpand Collapse

FileUploadResponse object { id, source_id, chunks_embedded, 13 more }

Representation of a single FileMetadata

id: string

The human-friendly ID of the File

Deprecatedsource_id: string

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: optional number

Number of chunks that have been embedded.

content: optional string

Optional full-text content of the file; only populated on demand due to its size.

created_at: optional string

The creation date of the file.

formatdate-time

error_message: optional string

Optional error message if the file failed processing.

file_creation_date: optional string

The creation date of the file.

file_last_modified_date: optional string

The last modified date of the file.

file_name: optional string

The name of the file.

file_path: optional string

The path to the file.

file_size: optional number

The size of the file in bytes.

file_type: optional string

The type of the file (MIME type).

original_file_name: optional string

The original name of the file as uploaded.

processing_status: optional "pending" or "parsing" or "embedding" or 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 number

Total number of chunks for the file.

updated_at: optional string

The update date of the file.

formatdate-time

FileListResponse object { id, source_id, chunks_embedded, 13 more }

Representation of a single FileMetadata

id: string

The human-friendly ID of the File

Deprecatedsource_id: string

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: optional number

Number of chunks that have been embedded.

content: optional string

Optional full-text content of the file; only populated on demand due to its size.

created_at: optional string

The creation date of the file.

formatdate-time

error_message: optional string

Optional error message if the file failed processing.

file_creation_date: optional string

The creation date of the file.

file_last_modified_date: optional string

The last modified date of the file.

file_name: optional string

The name of the file.

file_path: optional string

The path to the file.

file_size: optional number

The size of the file in bytes.

file_type: optional string

The type of the file (MIME type).

original_file_name: optional string

The original name of the file as uploaded.

processing_status: optional "pending" or "parsing" or "embedding" or 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 number

Total number of chunks for the file.

updated_at: optional string

The update date of the file.

formatdate-time

FileRetrieveResponse object { id, source_id, chunks_embedded, 13 more }

Representation of a single FileMetadata

id: string

The human-friendly ID of the File

Deprecatedsource_id: string

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: optional number

Number of chunks that have been embedded.

content: optional string

Optional full-text content of the file; only populated on demand due to its size.

created_at: optional string

The creation date of the file.

formatdate-time

error_message: optional string

Optional error message if the file failed processing.

file_creation_date: optional string

The creation date of the file.

file_last_modified_date: optional string

The last modified date of the file.

file_name: optional string

The name of the file.

file_path: optional string

The path to the file.

file_size: optional number

The size of the file in bytes.

file_type: optional string

The type of the file (MIME type).

original_file_name: optional string

The original name of the file as uploaded.

processing_status: optional "pending" or "parsing" or "embedding" or 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 number

Total number of chunks for the file.

updated_at: optional string

The update date of the file.

formatdate-time

FoldersAgents

List Agents For Folder

GET/v1/folders/{folder_id}/agents

ModelsExpand Collapse

AgentListResponse = array of string