Skip to content 
Tools
Delete Tool
Retrieve Tool
Update Tool
List Tools
Create Tool
Upsert Tool
Search Tools
ModelsExpand Collapse
Tool object { id, args_json_schema, created_by_id, 15 more }
Representation of a tool, which is a function that can be called by the agent.
default_requires_approval: optional boolean
Default value for whether or not executing this tool requires approval.
enable_parallel_execution: optional boolean
If set to True, then this tool will potentially be executed concurrently with other tools. Default False.
return_char_limit: optional number
The maximum number of characters in the response.
ToolCreate object { source_code, args_json_schema, default_requires_approval, 8 more }
default_requires_approval: optional boolean
Whether or not to require approval before executing this tool.
enable_parallel_execution: optional boolean
If set to True, then this tool will potentially be executed concurrently with other tools. Default False.
json_schema: optional map[unknown]
The JSON schema of the function (auto-generated from source_code if not provided)
ToolReturnMessage object { id, date, status, 13 more }
A message representing the return value of a tool call (generated by Letta executing the requested tool).
Args: id (str): The ID of the message date (datetime): The date the message was created in ISO format name (Optional[str]): The name of the sender of the message tool_return (str): The return value of the tool (deprecated, use tool_returns) status (Literal[“success”, “error”]): The status of the tool call (deprecated, use tool_returns) tool_call_id (str): A unique identifier for the tool call that generated this message (deprecated, use tool_returns) stdout (Optional[List(str)]): Captured stdout (e.g. prints, logs) from the tool invocation (deprecated, use tool_returns) stderr (Optional[List(str)]): Captured stderr from the tool invocation (deprecated, use tool_returns) tool_returns (Optional[List[ToolReturn]]): List of tool returns for multi-tool support
otid: optional string
The offline threading id (OTID). Set by the client to deduplicate requests. Used for idempotency in background streaming mode — each message in a request must have a unique OTID. Retries of the same request should reuse the same OTIDs.
tool_return: array of TextContent { text, signature, type } or ImageContent { source, type } or string
The tool return value - either a string or list of content parts (text/image)
array of TextContent { text, signature, type } or ImageContent { source, type }
ImageContent object { source, type }
source: object { url, type } or object { data, media_type, detail, type } or object { file_id, data, detail, 2 more }
The source of the image.
ToolSearchResult object { combined_score, tool, embedded_text, 2 more }
Result from a tool search operation.
The matched tool.
default_requires_approval: optional boolean
Default value for whether or not executing this tool requires approval.
enable_parallel_execution: optional boolean
If set to True, then this tool will potentially be executed concurrently with other tools. Default False.
return_char_limit: optional number
The maximum number of characters in the response.
The matched tool.
default_requires_approval: optional boolean
Default value for whether or not executing this tool requires approval.
enable_parallel_execution: optional boolean
If set to True, then this tool will potentially be executed concurrently with other tools. Default False.
return_char_limit: optional number
The maximum number of characters in the response.