Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB
tools

Modify Tool

Update an existing tool

patch/v1/tools/{tool_id}

Path parameters

tool_idstring required

Request body

descriptionstring nullable

The description of the tool.

tagsstring[] nullable

Metadata tags.

source_codestring nullable

The source code of the function.

source_typestring nullable

The type of the source code.

json_schemaobject nullable

The JSON schema of the function (auto-generated from source_code if not provided)

args_json_schemaobject nullable

The args JSON schema of the function.

return_char_limitinteger nullable

The maximum number of characters in the response.

metadata_object nullable

A dictionary of additional metadata for the tool.

default_requires_approvalboolean nullable

Whether or not to require approval before executing this tool.

Response

Successful Response

idstring

The human-friendly ID of the Tool

tool_type'custom' | 'letta_core' | 'letta_memory_core' | 'letta_multi_agent_core' | 'letta_sleeptime_core' | 'letta_voice_sleeptime_core' | 'letta_builtin' | 'letta_files_core' | 'external_langchain' | 'external_composio' | 'external_mcp'
descriptionstring nullable

The description of the tool.

source_typestring nullable

The type of the source code.

namestring nullable

The name of the function.

tagsstring[]

Metadata tags.

source_codestring nullable

The source code of the function.

json_schemaobject nullable

The JSON schema of the function.

args_json_schemaobject nullable

The args JSON schema of the function.

return_char_limitinteger

The maximum number of characters in the response.

default_requires_approvalboolean nullable

Default value for whether or not executing this tool requires approval.

created_by_idstring nullable

The id of the user that made this Tool.

last_updated_by_idstring nullable

The id of the user that made this Tool.

metadata_object nullable

A dictionary of additional metadata for the tool.

Example response

{
  "id": "tool-123e4567-e89b-12d3-a456-426614174000"
}