Skip to content
  • Auto
  • Light
  • Dark
DiscordForumGitHubSign up
API Reference

API Reference

Libraries

npm install @letta-ai/letta-client
pip install letta-client

API Overview

Agents

List Agents
get/v1/agents/
Create Agent
post/v1/agents/
Modify Agent
patch/v1/agents/{agent_id}
Retrieve Agent
get/v1/agents/{agent_id}
Delete Agent
delete/v1/agents/{agent_id}
Export Agent
get/v1/agents/{agent_id}/export
Import Agent
post/v1/agents/import

AgentsMessages

List Messages
get/v1/agents/{agent_id}/messages
Send Message
post/v1/agents/{agent_id}/messages
Modify Message
patch/v1/agents/{agent_id}/messages/{message_id}
Send Message Streaming
post/v1/agents/{agent_id}/messages/stream
Cancel Message
post/v1/agents/{agent_id}/messages/cancel
Send Message Async
post/v1/agents/{agent_id}/messages/async
Reset Messages
patch/v1/agents/{agent_id}/reset-messages
Summarize Messages
post/v1/agents/{agent_id}/summarize

AgentsBlocks

Retrieve Block For Agent
get/v1/agents/{agent_id}/core-memory/blocks/{block_label}
Modify Block For Agent
patch/v1/agents/{agent_id}/core-memory/blocks/{block_label}
List Blocks For Agent
get/v1/agents/{agent_id}/core-memory/blocks
Attach Block To Agent
patch/v1/agents/{agent_id}/core-memory/blocks/attach/{block_id}
Detach Block From Agent
patch/v1/agents/{agent_id}/core-memory/blocks/detach/{block_id}

AgentsTools

List Tools For Agent
get/v1/agents/{agent_id}/tools
Attach Tool To Agent
patch/v1/agents/{agent_id}/tools/attach/{tool_id}
Detach Tool From Agent
patch/v1/agents/{agent_id}/tools/detach/{tool_id}
Modify Approval For Tool
patch/v1/agents/{agent_id}/tools/approval/{tool_name}

AgentsFolders

Attach Folder To Agent
patch/v1/agents/{agent_id}/folders/attach/{folder_id}
Detach Folder From Agent
patch/v1/agents/{agent_id}/folders/detach/{folder_id}
List Folders For Agent
get/v1/agents/{agent_id}/folders

AgentsFiles

Close All Files For Agent
patch/v1/agents/{agent_id}/files/close-all
Open File For Agent
patch/v1/agents/{agent_id}/files/{file_id}/open
Close File For Agent
patch/v1/agents/{agent_id}/files/{file_id}/close
List Files For Agent
get/v1/agents/{agent_id}/files

AgentsGroups

List Groups For Agent
get/v1/agents/{agent_id}/groups

AgentsArchives

Attach Archive To Agent
patch/v1/agents/{agent_id}/archives/attach/{archive_id}
Detach Archive From Agent
patch/v1/agents/{agent_id}/archives/detach/{archive_id}

AgentsIdentities

Attach Identity To Agent
patch/v1/agents/{agent_id}/identities/attach/{identity_id}
Detach Identity From Agent
patch/v1/agents/{agent_id}/identities/detach/{identity_id}

Tools

Delete Tool
delete/v1/tools/{tool_id}
Retrieve Tool
get/v1/tools/{tool_id}
Modify Tool
patch/v1/tools/{tool_id}
List Tools
get/v1/tools/
Create Tool
post/v1/tools/
Upsert Tool
put/v1/tools/
Upsert Base Tools
post/v1/tools/add-base-tools

Blocks

List Blocks
get/v1/blocks/
Create Block
post/v1/blocks/
Modify Block
patch/v1/blocks/{block_id}
Delete Block
delete/v1/blocks/{block_id}
Retrieve Block
get/v1/blocks/{block_id}

BlocksAgents

List Agents For Block
get/v1/blocks/{block_id}/agents

Archives

Create Archive
post/v1/archives/
List Archives
get/v1/archives/
Modify Archive
patch/v1/archives/{archive_id}
Get Archive By Id
get/v1/archives/{archive_id}
Delete Archive
delete/v1/archives/{archive_id}

ArchivesPassages

Delete Passage From Archive
delete/v1/archives/{archive_id}/passages/{passage_id}

Folders

Retrieve Folder
get/v1/folders/{folder_id}
Modify Folder
patch/v1/folders/{folder_id}
Delete Folder
delete/v1/folders/{folder_id}
List Folders
get/v1/folders/
Create Folder
post/v1/folders/

FoldersFiles

Upload File To Folder
post/v1/folders/{folder_id}/upload
List Folder Files
get/v1/folders/{folder_id}/files
Delete File From Folder
delete/v1/folders/{folder_id}/{file_id}

FoldersAgents

List Agents For Folder
get/v1/folders/{folder_id}/agents

Models

List Llm Models
get/v1/models/

ModelsEmbeddings

List Embedding Models
get/v1/models/embedding

Mcp Servers

Create Mcp Server
post/v1/mcp-servers/
List Mcp Servers
get/v1/mcp-servers/
Get Mcp Server
get/v1/mcp-servers/{mcp_server_id}
Delete Mcp Server
delete/v1/mcp-servers/{mcp_server_id}
Update Mcp Server
patch/v1/mcp-servers/{mcp_server_id}
Connect Mcp Server
get/v1/mcp-servers/connect/{mcp_server_id}
Refresh Mcp Server Tools
patch/v1/mcp-servers/{mcp_server_id}/refresh

Mcp ServersTools

List Mcp Tools By Server
get/v1/mcp-servers/{mcp_server_id}/tools
Get Mcp Tool
get/v1/mcp-servers/{mcp_server_id}/tools/{tool_id}
Run Mcp Tool
post/v1/mcp-servers/{mcp_server_id}/tools/{tool_id}/run

Runs

List Runs
get/v1/runs/
Retrieve Run
get/v1/runs/{run_id}

RunsMessages

List Run Messages
get/v1/runs/{run_id}/messages
Retrieve Stream
post/v1/runs/{run_id}/stream

RunsUsage

Retrieve Run Usage
get/v1/runs/{run_id}/usage

RunsSteps

List Run Steps
get/v1/runs/{run_id}/steps

Steps

List Steps
get/v1/steps/
Retrieve Step
get/v1/steps/{step_id}

StepsMetrics

Retrieve Metrics For Step
get/v1/steps/{step_id}/metrics

StepsTrace

Retrieve Trace For Step
get/v1/steps/{step_id}/trace

StepsFeedback

Modify Feedback For Step
patch/v1/steps/{step_id}/feedback

StepsMessages

List Messages For Step
get/v1/steps/{step_id}/messages

Templates

TemplatesAgents

Create agents from a template (Cloud-only)
post/v1/templates/{template_version}/agents

Tags

List Tags
get/v1/tags/

Identities

List Identities
get/v1/identities/
Create Identity
post/v1/identities/
Upsert Identity
put/v1/identities/
Retrieve Identity
get/v1/identities/{identity_id}
Modify Identity
patch/v1/identities/{identity_id}
Delete Identity
delete/v1/identities/{identity_id}

IdentitiesProperties

Upsert Identity Properties
put/v1/identities/{identity_id}/properties

IdentitiesAgents

List Agents For Identity
get/v1/identities/{identity_id}/agents

IdentitiesBlocks

List Blocks For Identity
get/v1/identities/{identity_id}/blocks

Groups

List Groups
get/v1/groups/
Create Group
post/v1/groups/
Retrieve Group
get/v1/groups/{group_id}
Modify Group
patch/v1/groups/{group_id}
Delete Group
delete/v1/groups/{group_id}

GroupsMessages

Send Group Message
post/v1/groups/{group_id}/messages
List Group Messages
get/v1/groups/{group_id}/messages
Send Group Message Streaming
post/v1/groups/{group_id}/messages/stream
Modify Group Message
patch/v1/groups/{group_id}/messages/{message_id}
Reset Group Messages
patch/v1/groups/{group_id}/reset-messages

Batches

Create Batch
post/v1/messages/batches
List Batches
get/v1/messages/batches
Retrieve Batch
get/v1/messages/batches/{batch_id}
Cancel Batch
patch/v1/messages/batches/{batch_id}/cancel

BatchesMessages

List Messages For Batch
get/v1/messages/batches/{batch_id}/messages