api.md

Letta

Types:

• HealthResponse

Methods:

• client.health() -> HealthResponse

Agents

Types:

• AgentEnvironmentVariable
• AgentState
• AgentType
• AnthropicModelSettings
• AzureModelSettings
• BedrockModelSettings
• ChildToolRule
• ConditionalToolRule
• ContinueToolRule
• DeepseekModelSettings
• GoogleAIModelSettings
• GoogleVertexModelSettings
• GroqModelSettings
• InitToolRule
• JsonObjectResponseFormat
• JsonSchemaResponseFormat
• LettaMessageContentUnion
• MaxCountPerStepToolRule
• MessageCreate
• OpenAIModelSettings
• ParentToolRule
• RequiredBeforeExitToolRule
• RequiresApprovalToolRule
• TerminalToolRule
• TextResponseFormat
• TogetherModelSettings
• XaiModelSettings
• AgentDeleteResponse
• AgentExportFileResponse
• AgentImportFileResponse
• AgentRecompileResponse

Methods:

• client.agents.create({ ...params }) -> AgentState
• client.agents.retrieve(agentID, { ...params }) -> AgentState
• client.agents.update(agentID, { ...params }) -> AgentState
• client.agents.list({ ...params }) -> AgentStatesArrayPage
• client.agents.delete(agentID) -> unknown
• client.agents.exportFile(agentID, { ...params }) -> string
• client.agents.importFile({ ...params }) -> AgentImportFileResponse
• client.agents.recompile(agentID, { ...params }) -> string

Messages

Types:

• ApprovalCreate
• ApprovalRequestMessage
• ApprovalResponseMessage
• ApprovalReturn
• AssistantMessage
• EventMessage
• HiddenReasoningMessage
• ImageContent
• InternalMessage
• JobStatus
• JobType
• LettaAssistantMessageContentUnion
• LettaRequest
• LettaResponse
• LettaStreamingRequest
• LettaStreamingResponse
• LettaUserMessageContentUnion
• Message
• MessageRole
• MessageType
• OmittedReasoningContent
• ReasoningContent
• ReasoningMessage
• RedactedReasoningContent
• Run
• SummaryMessage
• SystemMessage
• TextContent
• ToolCall
• ToolCallContent
• ToolCallDelta
• ToolCallMessage
• ToolReturn
• ToolReturnContent
• UpdateAssistantMessage
• UpdateReasoningMessage
• UpdateSystemMessage
• UpdateUserMessage
• UserMessage
• MessageCancelResponse

Methods:

• client.agents.messages.create(agentID, { ...params }) -> LettaResponse
• client.agents.messages.list(agentID, { ...params }) -> MessagesArrayPage
• client.agents.messages.cancel(agentID, { ...params }) -> MessageCancelResponse
• client.agents.messages.compact(agentID, { ...params }) -> CompactionResponse
• client.agents.messages.createAsync(agentID, { ...params }) -> Run
• client.agents.messages.reset(agentID, { ...params }) -> AgentState | null
• client.agents.messages.stream(agentID, { ...params }) -> LettaStreamingResponse

Schedule

Types:

• ScheduleCreateResponse
• ScheduleRetrieveResponse
• ScheduleListResponse
• ScheduleDeleteResponse

Methods:

• client.agents.schedule.create(agentID, { ...params }) -> ScheduleCreateResponse
• client.agents.schedule.retrieve(scheduledMessageID, { ...params }) -> ScheduleRetrieveResponse
• client.agents.schedule.list(agentID, { ...params }) -> ScheduleListResponse
• client.agents.schedule.delete(scheduledMessageID, { ...params }) -> ScheduleDeleteResponse

Blocks

Types:

• Block
• BlockUpdate

Methods:

• client.agents.blocks.retrieve(blockLabel, { ...params }) -> BlockResponse
• client.agents.blocks.update(blockLabel, { ...params }) -> BlockResponse
• client.agents.blocks.list(agentID, { ...params }) -> BlockResponsesArrayPage
• client.agents.blocks.attach(blockID, { ...params }) -> AgentState
• client.agents.blocks.detach(blockID, { ...params }) -> AgentState

Tools

Types:

• ToolExecuteRequest
• ToolExecutionResult

Methods:

• client.agents.tools.list(agentID, { ...params }) -> ToolsArrayPage
• client.agents.tools.attach(toolID, { ...params }) -> AgentState | null
• client.agents.tools.detach(toolID, { ...params }) -> AgentState | null
• client.agents.tools.run(toolName, { ...params }) -> ToolExecutionResult
• client.agents.tools.updateApproval(toolName, { ...params }) -> AgentState | null

Folders

Types:

• FolderListResponse

Methods:

• client.agents.folders.list(agentID, { ...params }) -> FolderListResponsesArrayPage
• client.agents.folders.attach(folderID, { ...params }) -> AgentState | null
• client.agents.folders.detach(folderID, { ...params }) -> AgentState | null

Files

Types:

• FileListResponse
• FileCloseResponse
• FileCloseAllResponse
• FileOpenResponse

Methods:

• client.agents.files.list(agentID, { ...params }) -> FileListResponsesNextFilesPage
• client.agents.files.close(fileID, { ...params }) -> unknown
• client.agents.files.closeAll(agentID) -> FileCloseAllResponse
• client.agents.files.open(fileID, { ...params }) -> FileOpenResponse

Archives

Types:

• ArchiveAttachResponse
• ArchiveDetachResponse

Methods:

• client.agents.archives.attach(archiveID, { ...params }) -> unknown
• client.agents.archives.detach(archiveID, { ...params }) -> unknown

Passages

Types:

• PassageCreateResponse
• PassageListResponse
• PassageDeleteResponse
• PassageSearchResponse

Methods:

• client.agents.passages.create(agentID, { ...params }) -> PassageCreateResponse
• client.agents.passages.list(agentID, { ...params }) -> PassageListResponse
• client.agents.passages.delete(memoryID, { ...params }) -> unknown
• client.agents.passages.search(agentID, { ...params }) -> PassageSearchResponse

Identities

Types:

• IdentityAttachResponse
• IdentityDetachResponse

Methods:

• client.agents.identities.attach(identityID, { ...params }) -> unknown
• client.agents.identities.detach(identityID, { ...params }) -> unknown

Tools

Types:

• NpmRequirement
• PipRequirement
• Tool
• ToolCreate
• ToolReturnMessage
• ToolSearchRequest
• ToolSearchResult
• ToolType
• ToolDeleteResponse
• ToolSearchResponse

Methods:

• client.tools.create({ ...params }) -> Tool
• client.tools.retrieve(toolID) -> Tool
• client.tools.update(toolID, { ...params }) -> Tool
• client.tools.list({ ...params }) -> ToolsArrayPage
• client.tools.delete(toolID) -> unknown
• client.tools.search({ ...params }) -> ToolSearchResponse
• client.tools.upsert({ ...params }) -> Tool

Blocks

Types:

• BlockResponse
• CreateBlock
• BlockDeleteResponse

Methods:

• client.blocks.create({ ...params }) -> BlockResponse
• client.blocks.retrieve(blockID) -> BlockResponse
• client.blocks.update(blockID, { ...params }) -> BlockResponse
• client.blocks.list({ ...params }) -> BlockResponsesArrayPage
• client.blocks.delete(blockID) -> unknown

Agents

Methods:

• client.blocks.agents.list(blockID, { ...params }) -> AgentStatesArrayPage

Archives

Types:

• Archive
• VectorDBProvider

Methods:

• client.archives.create({ ...params }) -> Archive
• client.archives.retrieve(archiveID) -> Archive
• client.archives.update(archiveID, { ...params }) -> Archive
• client.archives.list({ ...params }) -> ArchivesArrayPage
• client.archives.delete(archiveID) -> void

Passages

Types:

• PassageCreateManyResponse

Methods:

• client.archives.passages.create(archiveID, { ...params }) -> Passage
• client.archives.passages.delete(passageID, { ...params }) -> void
• client.archives.passages.createMany(archiveID, { ...params }) -> PassageCreateManyResponse

Folders

Types:

• Folder
• FolderDeleteResponse

Methods:

• client.folders.create({ ...params }) -> Folder
• client.folders.retrieve(folderID) -> Folder
• client.folders.update(folderID, { ...params }) -> Folder
• client.folders.list({ ...params }) -> FoldersArrayPage
• client.folders.delete(folderID) -> unknown

Files

Types:

• FileRetrieveResponse
• FileListResponse
• FileUploadResponse

Methods:

• client.folders.files.retrieve(fileID, { ...params }) -> FileRetrieveResponse
• client.folders.files.list(folderID, { ...params }) -> FileListResponsesArrayPage
• client.folders.files.delete(fileID, { ...params }) -> void
• client.folders.files.upload(folderID, { ...params }) -> FileUploadResponse

Agents

Types:

• AgentListResponse

Methods:

• client.folders.agents.list(folderID, { ...params }) -> AgentListResponse

Models

Types:

• EmbeddingConfig
• EmbeddingModel
• LlmConfig
• Model
• ProviderCategory
• ProviderType
• ModelListResponse

Methods:

• client.models.list({ ...params }) -> ModelListResponse

Embeddings

Types:

• EmbeddingListResponse

Methods:

• client.models.embeddings.list() -> EmbeddingListResponse

McpServers

Types:

• CreateSseMcpServer
• CreateStdioMcpServer
• CreateStreamableHTTPMcpServer
• SseMcpServer
• StdioMcpServer
• StreamableHTTPMcpServer
• UpdateSseMcpServer
• UpdateStdioMcpServer
• UpdateStreamableHTTPMcpServer
• McpServerCreateResponse
• McpServerRetrieveResponse
• McpServerUpdateResponse
• McpServerListResponse
• McpServerRefreshResponse

Methods:

• client.mcpServers.create({ ...params }) -> McpServerCreateResponse
• client.mcpServers.retrieve(mcpServerID) -> McpServerRetrieveResponse
• client.mcpServers.update(mcpServerID, { ...params }) -> McpServerUpdateResponse
• client.mcpServers.list() -> McpServerListResponse
• client.mcpServers.delete(mcpServerID) -> void
• client.mcpServers.refresh(mcpServerID, { ...params }) -> unknown

Tools

Types:

• ToolListResponse

Methods:

• client.mcpServers.tools.retrieve(toolID, { ...params }) -> Tool
• client.mcpServers.tools.list(mcpServerID) -> ToolListResponse
• client.mcpServers.tools.run(toolID, { ...params }) -> ToolExecutionResult

Runs

Types:

• Job
• StopReasonType

Methods:

• client.runs.retrieve(runID) -> Run
• client.runs.list({ ...params }) -> RunsArrayPage

Messages

Types:

• MessageStreamResponse

Methods:

• client.runs.messages.list(runID, { ...params }) -> MessagesArrayPage
• client.runs.messages.stream(runID, { ...params }) -> unknown

Usage

Types:

• UsageRetrieveResponse

Methods:

• client.runs.usage.retrieve(runID) -> UsageRetrieveResponse

Steps

Methods:

• client.runs.steps.list(runID, { ...params }) -> StepsArrayPage

Trace

Types:

• TraceRetrieveResponse

Methods:

• client.runs.trace.retrieve(runID, { ...params }) -> TraceRetrieveResponse

Steps

Types:

• ProviderTrace
• Step

Methods:

• client.steps.retrieve(stepID) -> Step
• client.steps.list({ ...params }) -> StepsArrayPage

Metrics

Types:

• MetricRetrieveResponse

Methods:

• client.steps.metrics.retrieve(stepID) -> MetricRetrieveResponse

Trace

Methods:

• client.steps.trace.retrieve(stepID) -> ProviderTrace | null

Feedback

Methods:

• client.steps.feedback.create(stepID, { ...params }) -> Step

Messages

Types:

• MessageListResponse

Methods:

• client.steps.messages.list(stepID, { ...params }) -> MessageListResponsesArrayPage

Templates

Types:

• TemplateCreateResponse
• TemplateUpdateResponse
• TemplateDeleteResponse
• TemplateRollbackResponse
• TemplateSaveResponse

Methods:

• client.templates.create({ ...params }) -> TemplateCreateResponse
• client.templates.update(templateName, { ...params }) -> TemplateUpdateResponse
• client.templates.delete(templateName) -> TemplateDeleteResponse
• client.templates.rollback(templateName, { ...params }) -> TemplateRollbackResponse
• client.templates.save(templateName, { ...params }) -> TemplateSaveResponse

Agents

Types:

• AgentCreateResponse

Methods:

• client.templates.agents.create(templateVersion, { ...params }) -> AgentCreateResponse

Tags

Types:

• TagListResponse

Methods:

• client.tags.list({ ...params }) -> TagListResponse

Messages

Types:

• MessageSearchRequest
• MessageSearchResult
• MessageRetrieveResponse
• MessageListResponse
• MessageSearchResponse

Methods:

• client.messages.retrieve(messageID) -> MessageRetrieveResponse
• client.messages.list({ ...params }) -> MessageListResponse
• client.messages.search({ ...params }) -> MessageSearchResponse

Passages

Types:

• Passage
• PassageSearchResponse

Methods:

• client.passages.search({ ...params }) -> PassageSearchResponse

Conversations

Types:

• Conversation
• CreateConversation
• UpdateConversation
• ConversationListResponse
• ConversationDeleteResponse
• ConversationCancelResponse
• ConversationRecompileResponse

Methods:

• client.conversations.create({ ...params }) -> Conversation
• client.conversations.retrieve(conversationID) -> Conversation
• client.conversations.update(conversationID, { ...params }) -> Conversation
• client.conversations.list({ ...params }) -> ConversationListResponse
• client.conversations.delete(conversationID) -> unknown
• client.conversations.cancel(conversationID, { ...params }) -> ConversationCancelResponse
• client.conversations.recompile(conversationID, { ...params }) -> string

Messages

Types:

• CompactionRequest
• CompactionResponse
• MessageStreamResponse

Methods:

• client.conversations.messages.create(conversationID, { ...params }) -> LettaResponse
• client.conversations.messages.list(conversationID, { ...params }) -> MessagesArrayPage
• client.conversations.messages.compact(conversationID, { ...params }) -> CompactionResponse
• client.conversations.messages.stream(conversationID, { ...params }) -> unknown

AccessTokens

Types:

• AccessTokenCreateResponse
• AccessTokenListResponse
• AccessTokenDeleteResponse

Methods:

• client.accessTokens.create({ ...params }) -> AccessTokenCreateResponse
• client.accessTokens.list({ ...params }) -> AccessTokenListResponse
• client.accessTokens.delete(token, { ...params }) -> unknown