API Reference
Libraries
API Overview
Agents
List Agents
/v1/agents/
Create Agent
/v1/agents/
Modify Agent
/v1/agents/{agent_id}
Retrieve Agent
/v1/agents/{agent_id}
Delete Agent
/v1/agents/{agent_id}
Export Agent
/v1/agents/{agent_id}/export
Import Agent
/v1/agents/import
AgentsMessages
List Messages
/v1/agents/{agent_id}/messages
Send Message
/v1/agents/{agent_id}/messages
Modify Message
/v1/agents/{agent_id}/messages/{message_id}
Send Message Streaming
/v1/agents/{agent_id}/messages/stream
Cancel Message
/v1/agents/{agent_id}/messages/cancel
Send Message Async
/v1/agents/{agent_id}/messages/async
Reset Messages
/v1/agents/{agent_id}/reset-messages
Summarize Messages
/v1/agents/{agent_id}/summarize
AgentsBlocks
Retrieve Block For Agent
/v1/agents/{agent_id}/core-memory/blocks/{block_label}
Modify Block For Agent
/v1/agents/{agent_id}/core-memory/blocks/{block_label}
List Blocks For Agent
/v1/agents/{agent_id}/core-memory/blocks
Attach Block To Agent
/v1/agents/{agent_id}/core-memory/blocks/attach/{block_id}
Detach Block From Agent
/v1/agents/{agent_id}/core-memory/blocks/detach/{block_id}
AgentsTools
List Tools For Agent
/v1/agents/{agent_id}/tools
Attach Tool To Agent
/v1/agents/{agent_id}/tools/attach/{tool_id}
Detach Tool From Agent
/v1/agents/{agent_id}/tools/detach/{tool_id}
Modify Approval For Tool
/v1/agents/{agent_id}/tools/approval/{tool_name}
AgentsFolders
Attach Folder To Agent
/v1/agents/{agent_id}/folders/attach/{folder_id}
Detach Folder From Agent
/v1/agents/{agent_id}/folders/detach/{folder_id}
List Folders For Agent
/v1/agents/{agent_id}/folders
AgentsFiles
Close All Files For Agent
/v1/agents/{agent_id}/files/close-all
Open File For Agent
/v1/agents/{agent_id}/files/{file_id}/open
Close File For Agent
/v1/agents/{agent_id}/files/{file_id}/close
List Files For Agent
/v1/agents/{agent_id}/files
AgentsGroups
List Groups For Agent
/v1/agents/{agent_id}/groups
AgentsArchives
Attach Archive To Agent
/v1/agents/{agent_id}/archives/attach/{archive_id}
Detach Archive From Agent
/v1/agents/{agent_id}/archives/detach/{archive_id}
AgentsIdentities
Attach Identity To Agent
/v1/agents/{agent_id}/identities/attach/{identity_id}
Detach Identity From Agent
/v1/agents/{agent_id}/identities/detach/{identity_id}
Tools
Delete Tool
/v1/tools/{tool_id}
Retrieve Tool
/v1/tools/{tool_id}
Modify Tool
/v1/tools/{tool_id}
List Tools
/v1/tools/
Create Tool
/v1/tools/
Upsert Tool
/v1/tools/
Upsert Base Tools
/v1/tools/add-base-tools
Blocks
List Blocks
/v1/blocks/
Create Block
/v1/blocks/
Modify Block
/v1/blocks/{block_id}
Delete Block
/v1/blocks/{block_id}
Retrieve Block
/v1/blocks/{block_id}
BlocksAgents
List Agents For Block
/v1/blocks/{block_id}/agents
Archives
Create Archive
/v1/archives/
List Archives
/v1/archives/
Modify Archive
/v1/archives/{archive_id}
Get Archive By Id
/v1/archives/{archive_id}
Delete Archive
/v1/archives/{archive_id}
ArchivesPassages
Delete Passage From Archive
/v1/archives/{archive_id}/passages/{passage_id}
Folders
Retrieve Folder
/v1/folders/{folder_id}
Modify Folder
/v1/folders/{folder_id}
Delete Folder
/v1/folders/{folder_id}
List Folders
/v1/folders/
Create Folder
/v1/folders/
FoldersFiles
Upload File To Folder
/v1/folders/{folder_id}/upload
List Folder Files
/v1/folders/{folder_id}/files
Delete File From Folder
/v1/folders/{folder_id}/{file_id}
FoldersAgents
List Agents For Folder
/v1/folders/{folder_id}/agents
Models
List Llm Models
/v1/models/
ModelsEmbeddings
List Embedding Models
/v1/models/embedding
Mcp Servers
Create Mcp Server
/v1/mcp-servers/
List Mcp Servers
/v1/mcp-servers/
Get Mcp Server
/v1/mcp-servers/{mcp_server_id}
Delete Mcp Server
/v1/mcp-servers/{mcp_server_id}
Update Mcp Server
/v1/mcp-servers/{mcp_server_id}
Connect Mcp Server
/v1/mcp-servers/connect/{mcp_server_id}
Refresh Mcp Server Tools
/v1/mcp-servers/{mcp_server_id}/refresh
Mcp ServersTools
List Mcp Tools By Server
/v1/mcp-servers/{mcp_server_id}/tools
Get Mcp Tool
/v1/mcp-servers/{mcp_server_id}/tools/{tool_id}
Run Mcp Tool
/v1/mcp-servers/{mcp_server_id}/tools/{tool_id}/run
Runs
List Runs
/v1/runs/
Retrieve Run
/v1/runs/{run_id}
RunsMessages
List Run Messages
/v1/runs/{run_id}/messages
Retrieve Stream
/v1/runs/{run_id}/stream
RunsUsage
Retrieve Run Usage
/v1/runs/{run_id}/usage
RunsSteps
List Run Steps
/v1/runs/{run_id}/steps
Steps
List Steps
/v1/steps/
Retrieve Step
/v1/steps/{step_id}
StepsMetrics
Retrieve Metrics For Step
/v1/steps/{step_id}/metrics
StepsTrace
Retrieve Trace For Step
/v1/steps/{step_id}/trace
StepsFeedback
Modify Feedback For Step
/v1/steps/{step_id}/feedback
StepsMessages
List Messages For Step
/v1/steps/{step_id}/messages
Templates
TemplatesAgents
Create agents from a template (Cloud-only)
/v1/templates/{template_version}/agents
Tags
List Tags
/v1/tags/
Identities
List Identities
/v1/identities/
Create Identity
/v1/identities/
Upsert Identity
/v1/identities/
Retrieve Identity
/v1/identities/{identity_id}
Modify Identity
/v1/identities/{identity_id}
Delete Identity
/v1/identities/{identity_id}
IdentitiesProperties
Upsert Identity Properties
/v1/identities/{identity_id}/properties
IdentitiesAgents
List Agents For Identity
/v1/identities/{identity_id}/agents
IdentitiesBlocks
List Blocks For Identity
/v1/identities/{identity_id}/blocks
Groups
List Groups
/v1/groups/
Create Group
/v1/groups/
Retrieve Group
/v1/groups/{group_id}
Modify Group
/v1/groups/{group_id}
Delete Group
/v1/groups/{group_id}
GroupsMessages
Send Group Message
/v1/groups/{group_id}/messages
List Group Messages
/v1/groups/{group_id}/messages
Send Group Message Streaming
/v1/groups/{group_id}/messages/stream
Modify Group Message
/v1/groups/{group_id}/messages/{message_id}
Reset Group Messages
/v1/groups/{group_id}/reset-messages
Batches
Create Batch
/v1/messages/batches
List Batches
/v1/messages/batches
Retrieve Batch
/v1/messages/batches/{batch_id}
Cancel Batch
/v1/messages/batches/{batch_id}/cancel
BatchesMessages
List Messages For Batch
/v1/messages/batches/{batch_id}/messages