---
title: "Modify Folder"
method: PATCH
path: "/v1/folders/{folder_id}"
tags: ["folders"]
---

# Modify Folder

`PATCH /v1/folders/{folder_id}`

Update the name or documentation of an existing data folder.

## Path parameters

- `folder_id` string, required

## Request body

- SourceUpdate — Schema for updating an existing Source.
  - `name` string, nullable — The name of the source.
  - `description` string, nullable — The description of the source.
  - `instructions` string, nullable — Instructions for how to use the source.
  - `metadata` object, nullable — Metadata associated with the source.
  - `embedding_config` EmbeddingConfig — Configuration for embedding model connection and processing parameters.
    - `embedding_endpoint_type` 'openai' | 'anthropic' | 'bedrock' | 'google_ai' | 'google_vertex' | 'azure' | 'groq' | 'ollama' | 'webui' | 'webui-legacy' | 'lmstudio' | 'lmstudio-legacy' | 'llamacpp' | 'koboldcpp' | 'vllm' | 'hugging-face' | 'mistral' | 'together' | 'pinecone', required — The endpoint type for the model.
    - `embedding_endpoint` string, nullable — The endpoint for the model (`None` if local).
    - `embedding_model` string, required — The model for the embedding.
    - `embedding_dim` integer, required — The dimension of the embedding.
    - `embedding_chunk_size` integer, nullable — The chunk size of the embedding.
    - `handle` string, nullable — The handle for this config, in the format provider/model-name.
    - `batch_size` integer — The maximum batch size for processing embeddings.
    - `azure_endpoint` string, nullable — The Azure endpoint for the model.
    - `azure_version` string, nullable — The Azure version for the model.
    - `azure_deployment` string, nullable — The Azure deployment for the model.

## Response `200`

Successful Response

- Folder — Representation of a folder, which is a collection of files and passages. Parameters: id (str): The ID of the folder name (str): The name of the folder. embedding_config (EmbeddingConfig): The embedding configuration used by the folder. user_id (str): The ID of the user that created the folder. metadata (dict): Metadata associated with the folder. description (str): The description of the folder.
  - `name` string, required — The name of the folder.
  - `description` string, nullable — The description of the folder.
  - `instructions` string, nullable — Instructions for how to use the folder.
  - `metadata` object, nullable — Metadata associated with the folder.
  - `id` string — The human-friendly ID of the Source
  - `embedding_config` EmbeddingConfig, required — Configuration for embedding model connection and processing parameters.
    - `embedding_endpoint_type` 'openai' | 'anthropic' | 'bedrock' | 'google_ai' | 'google_vertex' | 'azure' | 'groq' | 'ollama' | 'webui' | 'webui-legacy' | 'lmstudio' | 'lmstudio-legacy' | 'llamacpp' | 'koboldcpp' | 'vllm' | 'hugging-face' | 'mistral' | 'together' | 'pinecone', required — The endpoint type for the model.
    - `embedding_endpoint` string, nullable — The endpoint for the model (`None` if local).
    - `embedding_model` string, required — The model for the embedding.
    - `embedding_dim` integer, required — The dimension of the embedding.
    - `embedding_chunk_size` integer, nullable — The chunk size of the embedding.
    - `handle` string, nullable — The handle for this config, in the format provider/model-name.
    - `batch_size` integer — The maximum batch size for processing embeddings.
    - `azure_endpoint` string, nullable — The Azure endpoint for the model.
    - `azure_version` string, nullable — The Azure version for the model.
    - `azure_deployment` string, nullable — The Azure deployment for the model.
  - `created_by_id` string, nullable — The id of the user that made this Tool.
  - `last_updated_by_id` string, nullable — The id of the user that made this Tool.
  - `created_at` string, date-time, nullable — The timestamp when the folder was created.
  - `updated_at` string, date-time, nullable — The timestamp when the folder was last updated.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/yu-code666/apis/letta-api.md) · [All operations](https://skmtc.dev/yu-code666/apis/letta-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/yu-code666/letta-api/revisions/42a9cd544e13/schema)