MCP协议服务器

openapi mcp服务器

Letta API的模型上下文协议（MCP）服务器。

描述

该服务器向API提供模型上下文协议（MCP）接口。

安装

1. 安装依赖项：

npm install

2. 创建一个 .env 文件基于 .env.example:

cp .env.example .env

3. 编辑 .env 文件添加API配置和授权详细信息。

配置

可以在中配置以下环境变量 .env 文件：

• API_BASE_URL：API的基本URL（必需）
• SERVER_NAME：MCP服务器的名称（默认：“openapi-MCP服务器”）
• SERVER_VERSION：MCP服务器的版本（默认：“1.0.0”）
• DEBUG：启用调试日志记录（true/false）（默认值：false）

用法

运行服务器

服务器同时提供JavaScript和TypeScript版本：

# Run JavaScript version
npm start

# Or run TypeScript version (compiles on the fly)
npm run start:ts

构建TypeScript版本

npm run build
cd dist
node server.js

用作MCP工具提供者

此服务器实现了模型上下文协议（MCP），可以与任何兼容MCP的消费者一起使用，如Claude.js客户端或其他MCP消费者。

从Claude.js客户端连接到此服务器的示例：

import { MCP } from "claude-js";
import { createStdio } from "claude-js/mcp";

// Create stdin/stdout transport
const transport = createStdio({ command: "node path/to/server.js" });

// Connect to the MCP server
const mcp = new MCP({ transport });
await mcp.connect();

// List available tools
const { tools } = await mcp.listTools();
console.log("Available tools:", tools);

// Call a tool
const result = await mcp.callTool({
    id: "TOOL-ID",
    arguments: { param1: "value1" }
});
console.log("Tool result:", result);

可用工具

此MCP服务器提供以下工具：

删除工具

• 身份证件: DELETE-v1-tools-tool-id
• 描述：按名称删除工具
• 方法: DELETE
• 路径: /v1/tools/{tool_id}

参数:

• tool_id：tool_id参数（必填）
• user_id：user_id参数

retrieve_tool

• 身份证件: GET-v1-tools-tool-id
• 描述：按ID获取工具
• 方法: GET
• 路径: /v1/tools/{tool_id}

参数:

• tool_id：tool_id参数（必填）
• user_id：user_id参数

修改工具

• 身份证件: PATCH-v1-tools-tool-id
• 描述：更新现有工具
• 方法: PATCH
• 路径: /v1/tools/{tool_id}

参数:

• tool_id：tool_id参数（必填）
• user_id：user_id参数

list_tools

• 身份证件: GET-v1-tools-
• 描述：获取属于用户组织的代理可用的所有工具的列表
• 方法: GET
• 路径: /v1/tools/

参数:

• after：参数后
• limit：限制参数
• name：name参数
• user_id：user_id参数

创建工具

• 身份证件: POST-v1-tools-
• 描述：创建新工具
• 方法: POST
• 路径: /v1/tools/

参数:

• user_id：user_id参数

upstret_tool

• 身份证件: PUT-v1-tools-
• 描述：创建或更新工具
• 方法: PUT
• 路径: /v1/tools/

参数:

• user_id：user_id参数

add_base_tools

• 身份证件: POST-v1-tools-add-base-tools
• 描述：上部基础工具
• 方法: POST
• 路径: /v1/tools/add-base-tools

参数:

• user_id：user_id参数

run_tool_from_source

• 身份证件: POST-v1-tools-run
• 描述：尝试从源代码构建工具，然后在提供的参数上运行它
• 方法: POST
• 路径: /v1/tools/run

参数:

• user_id：user_id参数

list_composio_apps

• 身份证件: GET-v1-tools-composio-apps
• 描述：获取所有Composio应用程序的列表
• 方法: GET
• 路径: /v1/tools/composio/apps

参数:

• user-id：用户id参数

list_coposio_actions_by_app

• 身份证件: GET-v1-tools-composio-apps-composio-app-name-actions
• 描述：获取特定应用程序的所有Composio操作列表
• 方法: GET
• 路径: /v1/tools/composio/apps/{composio_app_name}/actions

参数:

• composio_app_name：composio_app_name参数（必需）
• user_id：user_id参数

add_composio-tool

• 身份证件: POST-v1-tools-composio-composio-action-name
• 描述：按操作名称添加新的Composio工具（Composio将每个工具称为 Action)
• 方法: POST
• 路径: /v1/tools/composio/{composio_action_name}

参数:

• composio_action_name：composio_action_name参数（必需）
• user_id：user_id参数

list_mcp_servers

• 身份证件: GET-v1-tools-mcp-servers
• 描述：获取所有已配置的MCP服务器的列表
• 方法: GET
• 路径: /v1/tools/mcp/servers

参数:

• user-id：用户id参数

add_mcp_server

• 身份证件: PUT-v1-tools-mcp-servers
• 描述：将新的MCP服务器添加到Letta MCP服务器配置中
• 方法: PUT
• 路径: /v1/tools/mcp/servers

参数:

• user_id：user_id参数

list_mcp_tools_by_server

• 身份证件: GET-v1-tools-mcp-servers-mcp-server-name-tools
• 描述：获取特定MCP服务器的所有工具列表
• 方法: GET
• 路径: /v1/tools/mcp/servers/{mcp_server_name}/tools

参数:

• mcp_server_name：mcp_server_name参数（必需）
• user_id：user_id参数

add_mcp_tool

• 身份证件: POST-v1-tools-mcp-servers-mcp-server-name-mcp-tool-name
• 描述：通过MCP服务器+工具名称将新的MCP工具注册为Letta服务器
• 方法: POST
• 路径: /v1/tools/mcp/servers/{mcp_server_name}/{mcp_tool_name}

参数:

• mcp_server_name：mcp_server_name参数（必需）
• mcp_tool_name：mcp_tolog_name参数（必需）
• user_id：user_id参数

delete_mcp_server

• 身份证件: DELETE-v1-tools-mcp-servers-mcp-server-name
• 描述：将新的MCP服务器添加到Letta MCP服务器配置中
• 方法: DELETE
• 路径: /v1/tools/mcp/servers/{mcp_server_name}

参数:

• mcp_server_name：mcp_server_name参数（必需）
• user_id：user_id参数

检索源

• 身份证件: GET-v1-sources-source-id
• 描述：获取所有来源
• 方法: GET
• 路径: /v1/sources/{source_id}

参数:

• source_id：source_id参数（必填）
• user_id：user_id参数

modify_source

• 身份证件: PATCH-v1-sources-source-id
• 描述：更新现有数据源的名称或文档。
• 方法: PATCH
• 路径: /v1/sources/{source_id}

参数:

• source_id：source_id参数（必填）
• user_id：user_id参数

删除_源

• 身份证件: DELETE-v1-sources-source-id
• 描述：删除数据源。
• 方法: DELETE
• 路径: /v1/sources/{source_id}

参数:

• source_id：source_id参数（必填）
• user_id：user_id参数

get_source_id_by_name

• 身份证件: GET-v1-sources-name-source-name
• 描述：按名称获取源
• 方法: GET
• 路径: /v1/sources/name/{source_name}

参数:

• source_name：source_name参数（必需）
• user_id：user_id参数

列表_来源

• 身份证件: GET-v1-sources-
• 描述：列出用户创建的所有数据源。
• 方法: GET
• 路径: /v1/sources/

参数:

• user_id：user_id参数

create_source

• 身份证件: POST-v1-sources-
• 描述：创建新的数据源。
• 方法: POST
• 路径: /v1/sources/

参数:

• user_id：user_id参数

upload_file_to_source

• 身份证件: POST-v1-sources-source-id-upload
• 描述：将文件上载到数据源。
• 方法: POST
• 路径: /v1/sources/{source_id}/upload

参数:

• source_id：source_id参数（必填）
• user_id：user_id参数

列表_来源_消息

• 身份证件: GET-v1-sources-source-id-passages
• 描述：列出与数据源关联的所有段落。
• 方法: GET
• 路径: /v1/sources/{source_id}/passages

参数:

• source_id：source_id参数（必填）
• user_id：user_id参数

list_source_files

• 身份证件: GET-v1-sources-source-id-files
• 描述：列出与数据源关联的分页文件。
• 方法: GET
• 路径: /v1/sources/{source_id}/files

参数:

• source_id：source_id参数（必填）
• limit：要返回的文件数
• after：分页光标用于获取下一组结果
• user_id：user_id参数

delete_file_from_source

• 身份证件: DELETE-v1-sources-source-id-file-id
• 描述：删除数据源。
• 方法: DELETE
• 路径: /v1/sources/{source_id}/{file_id}

参数:

• source_id：source_id参数（必填）
• file_id：file_id参数（必填）
• user_id：user_id参数

列表_代理

• 身份证件: GET-v1-agents-
• 描述：列出与给定用户关联的所有代理。

此端点检索所有代理及其配置的列表 与指定的用户ID相关联。

• 方法: GET
• 路径: /v1/agents/

参数:

• name：代理人姓名
• tags：用于筛选代理的标签列表
• match_all_tags：如果为True，则只返回与所有给定标签匹配的代理。否则，返回具有任何传入标签的代理。
• before：分页光标
• after：分页光标
• limit：分页限制
• query_text：按名称搜索代理
• project_id：按项目ID搜索代理
• template_id：按模板ID搜索代理
• base_template_id：按基本模板ID搜索代理
• identity_id：按身份ID搜索代理
• identifier_keys：按标识符键搜索代理
• include_relationships：指定要在响应中包含哪些关系字段（例如“工具”、“源”、“内存”）。如果未提供，默认情况下会加载所有关系。使用此方法可以通过减少不必要的连接来优化性能。
• ascending：是将代理从最旧到最新排序（True）还是从最新到最旧排序（False，默认）
• user_id：user_id参数

create_agent

• 身份证件: POST-v1-agents-
• 描述：使用指定的配置创建新代理。
• 方法: POST
• 路径: /v1/agents/

参数:

• user_id：user_id参数
• X-Project：X项目参数

出口代理系列化

• 身份证件: GET-v1-agents-agent-id-export
• 描述：导出代理的序列化JSON表示。
• 方法: GET
• 路径: /v1/agents/{agent_id}/export

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

导入_代理_序列化

• 身份证件: POST-v1-agents-import
• 描述：导入序列化的代理文件，然后在系统中重新创建代理。
• 方法: POST
• 路径: /v1/agents/import

参数:

• append_copy_suffix：如果设置为True，则在代理名称末尾附加“_copy”。
• override_existing_tools：如果设置为True，现有工具的源代码可能会被上传的工具定义覆盖。请注意，Letta核心工具永远不能在外部更新。
• project_id：将上传的代理与之关联的项目ID。
• user_id：user_id参数

retrieve_agent_context_window

• 身份证件: GET-v1-agents-agent-id-context
• 描述：检索特定代理的上下文窗口。
• 方法: GET
• 路径: /v1/agents/{agent_id}/context

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

修改代理

• 身份证件: PATCH-v1-agents-agent-id
• 描述：更新现有代理
• 方法: PATCH
• 路径: /v1/agents/{agent_id}

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

检索代理

• 身份证件: GET-v1-agents-agent-id
• 描述：获取代理的状态。
• 方法: GET
• 路径: /v1/agents/{agent_id}

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

删除代理

• 身份证件: DELETE-v1-agents-agent-id
• 描述：删除代理。
• 方法: DELETE
• 路径: /v1/agents/{agent_id}

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

list_agent_tools

• 身份证件: GET-v1-agents-agent-id-tools
• 描述：从现有代理获取工具
• 方法: GET
• 路径: /v1/agents/{agent_id}/tools

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

附件工具

• 身份证件: PATCH-v1-agents-agent-id-tools-attach-tool-id
• 描述：将工具附加到代理上。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/tools/attach/{tool_id}

参数:

• agent_id：agent_id参数（必填）
• tool_id：tool_id参数（必填）
• user_id：user_id参数

detach_tool

• 身份证件: PATCH-v1-agents-agent-id-tools-detach-tool-id
• 描述：从代理中分离工具。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/tools/detach/{tool_id}

参数:

• agent_id：agent_id参数（必填）
• tool_id：tool_id参数（必填）
• user_id：user_id参数

附件_来源_代理

• 身份证件: PATCH-v1-agents-agent-id-sources-attach-source-id
• 描述：将源附加到代理。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/sources/attach/{source_id}

参数:

• agent_id：agent_id参数（必填）
• source_id：source_id参数（必填）
• user_id：user_id参数

详细信息_来源_客服

• 身份证件: PATCH-v1-agents-agent-id-sources-detach-source-id
• 描述：从代理中分离源。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/sources/detach/{source_id}

参数:

• agent_id：agent_id参数（必填）
• source_id：source_id参数（必填）
• user_id：user_id参数

列表_代理_来源

• 身份证件: GET-v1-agents-agent-id-sources
• 描述：获取与代理关联的源。
• 方法: GET
• 路径: /v1/agents/{agent_id}/sources

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

retrieve_agent_memory

• 身份证件: GET-v1-agents-agent-id-core-memory
• 描述：检索特定代理的内存状态。 此端点获取由用户ID和代理ID标识的代理的当前内存状态。
• 方法: GET
• 路径: /v1/agents/{agent_id}/core-memory

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

retrieve_core_memory_block

• 身份证件: GET-v1-agents-agent-id-core-memory-blocks-block-label
• 描述：从代理检索核心内存块。
• 方法: GET
• 路径: /v1/agents/{agent_id}/core-memory/blocks/{block_label}

参数:

• agent_id：agent_id参数（必填）
• block_label：block_label参数（必需）
• user_id：user_id参数

modify_core_memory_block

• 身份证件: PATCH-v1-agents-agent-id-core-memory-blocks-block-label
• 描述：更新代理的核心内存块。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/core-memory/blocks/{block_label}

参数:

• agent_id：agent_id参数（必填）
• block_label：block_label参数（必需）
• user_id：user_id参数

list_core_memory_blocks

• 身份证件: GET-v1-agents-agent-id-core-memory-blocks
• 描述：检索特定代理的核心内存块。
• 方法: GET
• 路径: /v1/agents/{agent_id}/core-memory/blocks

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

附件_代码_内存_块

• 身份证件: PATCH-v1-agents-agent-id-core-memory-blocks-attach-block-id
• 描述：将核心记忆块附加到代理上。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/core-memory/blocks/attach/{block_id}

参数:

• agent_id：agent_id参数（必填）
• block_id：block_id参数（必填）
• user_id：user_id参数

detach_core_memory_block

• 身份证件: PATCH-v1-agents-agent-id-core-memory-blocks-detach-block-id
• 描述：从代理中分离核心内存块。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/core-memory/blocks/detach/{block_id}

参数:

• agent_id：agent_id参数（必填）
• block_id：block_id参数（必填）
• user_id：user_id参数

列表_消息

• 身份证件: GET-v1-agents-agent-id-archival-memory
• 描述：检索代理的存档内存存储中的内存（分页查询）。
• 方法: GET
• 路径: /v1/agents/{agent_id}/archival-memory

参数:

• agent_id：agent_id参数（必填）
• after：启动查询范围的内存的唯一ID。
• before：结束查询范围的内存的唯一ID。
• limit：答复中应包括多少结果。
• search：按文本搜索段落
• ascending：是将段落从最旧到最新排序（True，默认）还是从最新到最旧排序（False）
• user_id：user_id参数

创建消息

• 身份证件: POST-v1-agents-agent-id-archival-memory
• 描述：将内存插入代理的存档内存存储中。
• 方法: POST
• 路径: /v1/agents/{agent_id}/archival-memory

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

修改消息

• 身份证件: PATCH-v1-agents-agent-id-archival-memory-memory-id
• 描述：修改代理存档内存存储中的内存。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/archival-memory/{memory_id}

参数:

• agent_id：agent_id参数（必填）
• memory_id：memory_id参数（必填）
• user_id：user_id参数

删除消息

• 身份证件: DELETE-v1-agents-agent-id-archival-memory-memory-id
• 描述：从代理的存档内存存储中删除内存。
• 方法: DELETE
• 路径: /v1/agents/{agent_id}/archival-memory/{memory_id}

参数:

• agent_id：agent_id参数（必填）
• memory_id：memory_id参数（必填）
• user_id：user_id参数

list_消息

• 身份证件: GET-v1-agents-agent-id-messages
• 描述：检索代理的消息历史记录。
• 方法: GET
• 路径: /v1/agents/{agent_id}/messages

参数:

• agent_id：agent_id参数（必填）
• after：消息，之后检索返回的消息。
• before：用于检索返回消息的消息。
• limit：要检索的最大邮件数。
• use_assistant_message：是否使用助理消息
• assistant_message_tool_name：指定消息工具的名称。
• assistant_message_tool_kwarg：消息参数的名称。
• user_id：user_id参数

send_message

• 身份证件: POST-v1-agents-agent-id-messages
• 描述：处理用户消息并返回代理的响应。 此端点接受来自用户的消息，并通过代理对其进行处理。
• 方法: POST
• 路径: /v1/agents/{agent_id}/messages

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

修改消息

• 身份证件: PATCH-v1-agents-agent-id-messages-message-id
• 描述：更新与代理关联的消息的详细信息。
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/messages/{message_id}

参数:

• agent_id：agent_id参数（必填）
• message_id：message_id参数（必填）
• user_id：user_id参数

create_agent_message_stream

• 身份证件: POST-v1-agents-agent-id-messages-stream
• 描述：处理用户消息并返回代理的响应。 此端点接受来自用户的消息，并通过代理对其进行处理。 它将始终流式传输响应的步骤，如果“stream_tokens”设置为True，则流式传输令牌。
• 方法: POST
• 路径: /v1/agents/{agent_id}/messages/stream

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

create_agent_message_async

• 身份证件: POST-v1-agents-agent-id-messages-async
• 描述：异步处理用户消息并返回run对象。 实际处理发生在后台，可以使用运行ID检查状态。
• 方法: POST
• 路径: /v1/agents/{agent_id}/messages/async

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

重置消息

• 身份证件: PATCH-v1-agents-agent-id-reset-messages
• 描述：重置代理的消息
• 方法: PATCH
• 路径: /v1/agents/{agent_id}/reset-messages

参数:

• agent_id：agent_id参数（必填）
• add_default_initial_messages：如果为true，则在重置后添加默认的初始消息。
• user_id：user_id参数

创建组

• 身份证件: POST-v1-groups-
• 描述：使用指定的配置创建新的多代理组。
• 方法: POST
• 路径: /v1/groups/

参数:

• user_id：user_id参数
• X-Project：X项目参数

list_groups

• 身份证件: GET-v1-groups-
• 描述：获取与查询匹配的所有多代理组。
• 方法: GET
• 路径: /v1/groups/

参数:

• manager_type：按经理类型搜索组
• before：分页光标
• after：分页光标
• limit：分页限制
• project_id：按项目id搜索组
• user_id：user_id参数

upstret_group

• 身份证件: PUT-v1-groups-
• 描述：使用指定的配置创建新的多代理组。
• 方法: PUT
• 路径: /v1/groups/

参数:

• user_id：user_id参数
• X-Project：X项目参数

删除组

• 身份证件: DELETE-v1-groups-group-id
• 描述：删除多代理组。
• 方法: DELETE
• 路径: /v1/groups/{group_id}

参数:

• group_id：group_id参数（必填）
• user_id：user_id参数

send_group_message

• 身份证件: POST-v1-groups-group-id-messages
• 描述：处理用户消息并返回组的响应。 此端点接受来自用户的消息，并根据指定的模式通过组中的代理进行处理
• 方法: POST
• 路径: /v1/groups/{group_id}/messages

参数:

• agent_id：agent_id参数（必填）
• user_id：user_id参数

list_group_消息

• 身份证件: GET-v1-groups-group-id-messages
• 描述：检索代理的消息历史记录。
• 方法: GET
• 路径: /v1/groups/{group_id}/messages

参数:

• group_id：group_id参数（必填）
• after：消息，之后检索返回的消息。
• before：用于检索返回消息的消息。
• limit：要检索的最大邮件数。
• use_assistant_message：是否使用助理消息
• assistant_message_tool_name：指定消息工具的名称。
• assistant_message_tool_kwarg：消息参数的名称。
• user_id：user_id参数

send_group_message_streaming

• 身份证件: POST-v1-groups-group-id-messages-stream
• 描述：处理用户消息并返回组的响应。 此端点接受来自用户的消息，并根据指定的模式通过组中的代理对其进行处理。 它将始终流式传输响应的步骤，如果“stream_tokens”设置为True，则流式传输令牌。
• 方法: POST
• 路径: /v1/groups/{group_id}/messages/stream

参数:

• group_id：group_id参数（必填）
• user_id：user_id参数

list_identities

• 身份证件: GET-v1-identities-
• 描述：获取数据库中所有身份的列表
• 方法: GET
• 路径: /v1/identities/

参数:

• name：name参数
• project_id：project_id参数
• identifier_key：identifier_key参数
• identity_type：identity_type参数
• before：参数之前
• after：参数后
• limit：限制参数
• user_id：user_id参数

创建标识

• 身份证件: POST-v1-identities-
• 描述：向/v1/identity发出POST请求/
• 方法: POST
• 路径: /v1/identities/

参数:

• user_id：user_id参数
• X-Project：X项目参数

uprt_identity

• 身份证件: PUT-v1-identities-
• 描述：向/v1/identity发出PUT请求/
• 方法: PUT
• 路径: /v1/identities/

参数:

• user_id：user_id参数
• X-Project：X项目参数

retrieve_identity

• 身份证件: GET-v1-identities-identity-id
• 描述：向/v1/identity/｛identity_id｝发出GET请求
• 方法: GET
• 路径: /v1/identities/{identity_id}

参数:

• identity_id：identity_id参数（必填）
• user_id：user_id参数

update_identity

• 身份证件: PATCH-v1-identities-identity-id
• 描述：向/v1/identity/｛identity_id｝发出PATCH请求
• 方法: PATCH
• 路径: /v1/identities/{identity_id}

参数:

• identity_id：identity_id参数（必填）
• user_id：user_id参数

删除标识

• 身份证件: DELETE-v1-identities-identity-id
• 描述：通过标识密钥删除标识
• 方法: DELETE
• 路径: /v1/identities/{identity_id}

参数:

• identity_id：identity_id参数（必填）
• user_id：user_id参数

list_models

• 身份证件: GET-v1-models-
• 描述：向/v1/models发出GET请求/
• 方法: GET
• 路径: /v1/models/

无需参数。

列表嵌入模型

• 身份证件: GET-v1-models-embedding
• 描述：向/v1/models/embedded发出GET请求
• 方法: GET
• 路径: /v1/models/embedding

无需参数。

list_blocks

• 身份证件: GET-v1-blocks-
• 描述：向/v1/blocks发出GET请求/
• 方法: GET
• 路径: /v1/blocks/

参数:

• label：要包含的标签（例如人、角色）
• templates_only：是否仅包含模板
• name：区块名称
• identity_id：按标识符id搜索代理
• identifier_keys：按标识符键搜索代理
• user_id：user_id参数

create_block

• 身份证件: POST-v1-blocks-
• 描述：向/v1/blocks发出POST请求/
• 方法: POST
• 路径: /v1/blocks/

参数:

• user_id：user_id参数

modify_block

• 身份证件: PATCH-v1-blocks-block-id
• 描述：向/v1/blocks/{block_id}发出PATCH请求
• 方法: PATCH
• 路径: /v1/blocks/{block_id}

参数:

• block_id：block_id参数（必填）
• user_id：user_id参数

delete_block

• 身份证件: DELETE-v1-blocks-block-id
• 描述：向/v1/blocks/{block_id}发出DELETE请求
• 方法: DELETE
• 路径: /v1/blocks/{block_id}

参数:

• block_id：block_id参数（必填）
• user_id：user_id参数

retrieve_block

• 身份证件: GET-v1-blocks-block-id
• 描述：向/v1/blocks/{block_id}发出GET请求
• 方法: GET
• 路径: /v1/blocks/{block_id}

参数:

• block_id：block_id参数（必填）
• user_id：user_id参数

list_agents_for_block

• 身份证件: GET-v1-blocks-block-id-agents
• 描述：检索与指定块关联的所有代理。 如果该块不存在，则引发404。
• 方法: GET
• 路径: /v1/blocks/{block_id}/agents

参数:

• block_id：block_id参数（必填）
• user_id：user_id参数

list_jobs

• 身份证件: GET-v1-jobs-
• 描述：列出所有作业。
• 方法: GET
• 路径: /v1/jobs/

参数:

• source_id：仅列出与源关联的作业。
• user_id：user_id参数

list_active_jobs

• 身份证件: GET-v1-jobs-active
• 描述：列出所有活动作业。
• 方法: GET
• 路径: /v1/jobs/active

参数:

• user_id：user_id参数

检索作业

• 身份证件: GET-v1-jobs-job-id
• 描述：获取作业的状态。
• 方法: GET
• 路径: /v1/jobs/{job_id}

参数:

• job_id：job_id参数（必填）
• user_id：user_id参数

删除job

• 身份证件: DELETE-v1-jobs-job-id
• 描述：按job_id删除作业。
• 方法: DELETE
• 路径: /v1/jobs/{job_id}

参数:

• job_id：job_id参数（必填）
• user_id：user_id参数

健康检查

• 身份证件: GET-v1-health-
• 描述：向/v1/health发出GET请求/
• 方法: GET
• 路径: /v1/health/

无需参数。

create_sandbox_config _v1_sandbox_config发布

• 身份证件: POST-v1-sandbox-config-
• 描述：向/v1/sandbox配置发出POST请求/
• 方法: POST
• 路径: /v1/sandbox-config/

参数:

• user-id：用户id参数

list_sandbox_configs_v1_sandbox_config_get

• 身份证件: GET-v1-sandbox-config-
• 描述：向/v1/sandbox配置发出GET请求/
• 方法: GET
• 路径: /v1/sandbox-config/

参数:

• limit：要返回的结果数
• after：分页光标用于获取下一组结果
• sandbox_type：此特定沙盒类型的筛选器
• user-id：用户id参数

create_default_e2b_sandbox_config _v1_sandbox_config _e2b_default_post

• 身份证件: POST-v1-sandbox-config-e2b-default
• 描述：向/v1/sandbox-config/e2b/default发出POST请求
• 方法: POST
• 路径: /v1/sandbox-config/e2b/default

参数:

• user-id：用户id参数

create_default_local_sandbox_config _v1_sandbox_config _local_default_post

• 身份证件: POST-v1-sandbox-config-local-default
• 描述：向/v1/sandbox config/local/default发出POST请求
• 方法: POST
• 路径: /v1/sandbox-config/local/default

参数:

• user-id：用户id参数

create_custom_local_sandbox_config v1.sandbox_config _local_post

• 身份证件: POST-v1-sandbox-config-local
• 描述：创建或更新自定义LocalSandboxConfig，包括pip_requiries。
• 方法: POST
• 路径: /v1/sandbox-config/local

参数:

• user-id：用户id参数

update_sandbox_config _v1_sandbox_config __沙盒_config _补丁

• 身份证件: PATCH-v1-sandbox-config-sandbox-config-id
• 描述：向/v1/sandbox-config/{sandbox_config_id}发出PATCH请求
• 方法: PATCH
• 路径: /v1/sandbox-config/{sandbox_config_id}

参数:

• sandbox_config_id：sandbox_config_id参数（必填）
• user-id：用户id参数

delete_sandbox_config _v1_sandbox_config __沙盒_config _删除

• 身份证件: DELETE-v1-sandbox-config-sandbox-config-id
• 描述：向/v1/sandbox-config/{sandbox_config_id}发出DELETE请求
• 方法: DELETE
• 路径: /v1/sandbox-config/{sandbox_config_id}

参数:

• sandbox_config_id：sandbox_config_id参数（必填）
• user-id：用户id参数

force_recreate_local_sandbox_venv_v1_sandbox_configure_cal_recreate_venv_post

• 身份证件: POST-v1-sandbox-config-local-recreate-venv
• 描述：强制为本地沙盒重新创建虚拟环境。 删除并重新创建venv，然后重新安装所需的依赖项。
• 方法: POST
• 路径: /v1/sandbox-config/local/recreate-venv

参数:

• user-id：用户id参数

create_sandbox_env_var_v1_sandbox_config沙盒_config环境变量发布

• 身份证件: POST-v1-sandbox-config-sandbox-config-id-environment-variable
• 描述：向/v1/sandbox-config/{sandbox_config_id}/环境变量发出POST请求
• 方法: POST
• 路径: /v1/sandbox-config/{sandbox_config_id}/environment-variable

参数:

• sandbox_config_id：sandbox_config_id参数（必填）
• user-id：用户id参数

list_sandbox_env_vars_v1_sandbox_config_沙盒_confid_environment_variable_get

• 身份证件: GET-v1-sandbox-config-sandbox-config-id-environment-variable
• 描述：向/v1/sandbox-config/{sandbox_config_id}/环境变量发出GET请求
• 方法: GET
• 路径: /v1/sandbox-config/{sandbox_config_id}/environment-variable

参数:

• sandbox_config_id：sandbox_config_id参数（必填）
• limit：要返回的结果数
• after：分页光标用于获取下一组结果
• user-id：用户id参数

update_sandbox_env_var_v1_sandbox_config _环境变量__env_var_id_patch

• 身份证件: PATCH-v1-sandbox-config-environment-variable-env-var-id
• 描述：向/v1/沙盒配置/环境变量/{env_var_id}发出PATCH请求
• 方法: PATCH
• 路径: /v1/sandbox-config/environment-variable/{env_var_id}

参数:

• env_var_id：env_var_id参数（必填）
• user-id：用户id参数

delete_sandbox_env_var_v1_sandbox_config _环境变量__env_var_id_delete

• 身份证件: DELETE-v1-sandbox-config-environment-variable-env-var-id
• 描述：向/v1/沙盒配置/环境变量/{env_var_id}发出DELETE请求
• 方法: DELETE
• 路径: /v1/sandbox-config/environment-variable/{env_var_id}

参数:

• env_var_id：env_var_id参数（必填）
• user-id：用户id参数

list_提供者

• 身份证件: GET-v1-providers-
• 描述：获取数据库中所有自定义提供程序的列表
• 方法: GET
• 路径: /v1/providers/

参数:

• after：参数后
• limit：限制参数
• user_id：user_id参数

create_provider

• 身份证件: POST-v1-providers-
• 描述：创建新的自定义提供程序
• 方法: POST
• 路径: /v1/providers/

参数:

• user_id：user_id参数

修改提供者

• 身份证件: PATCH-v1-providers-
• 描述：更新现有的自定义提供程序
• 方法: PATCH
• 路径: /v1/providers/

参数:

• user_id：user_id参数

删除提供者

• 身份证件: DELETE-v1-providers-
• 描述：删除现有的自定义提供程序
• 方法: DELETE
• 路径: /v1/providers/

参数:

• provider_id：要删除的provider_id密钥。（必填）
• user_id：user_id参数

list_run

• 身份证件: GET-v1-runs-
• 描述：列出所有跑步记录。
• 方法: GET
• 路径: /v1/runs/

参数:

• user_id：user_id参数

list_active_run

• 身份证件: GET-v1-runs-active
• 描述：列出所有活动跑步记录。
• 方法: GET
• 路径: /v1/runs/active

参数:

• user_id：user_id参数

retrieverun

• 身份证件: GET-v1-runs-run-id
• 描述：获取跑步状态。
• 方法: GET
• 路径: /v1/runs/{run_id}

参数:

• run_id：run_id参数（必需）
• user_id：user_id参数

delete_run

• 身份证件: DELETE-v1-runs-run-id
• 描述：按run_id删除跑步记录。
• 方法: DELETE
• 路径: /v1/runs/{run_id}

参数:

• run_id：run_id参数（必需）
• user_id：user_id参数

list_run_消息

• 身份证件: GET-v1-runs-run-id-messages
• 描述：使用筛选选项获取与跑步相关的消息。

Args： run_id：运行的id before：用于分页的光标。 before 是一个对象ID，用于定义您在列表中的位置。例如，如果你发出一个列表请求并收到100个对象，从obj_foo开始，你的后续调用可以包含before=obj_fou，以获取列表的前一页。 after：用于分页的光标。 after 是一个对象ID，用于定义您在列表中的位置。例如，如果你发出一个列表请求并收到100个对象，以obj_foo结尾，你的后续调用可以包含after=obj_fou，以获取列表的下一页。 limit：要返回的最大邮件数 order：按对象的created_at时间戳排序。asc表示升序，desc表示降序。 角色：按角色筛选（用户/助理/系统/工具） return_message_object:是返回message对象还是LettaMessage对象 user_id：发出请求的用户的id

退货： 与跑步相关的消息列表。默认值为列表[LettaMessage]。

• 方法: GET
• 路径: /v1/runs/{run_id}/messages

参数:

• run_id：run_id参数（必需）
• before：分页光标
• after：分页光标
• limit：要返回的最大邮件数
• order：按对象的created_at时间戳排序。asc表示升序，desc表示降序。
• role：按角色筛选
• user_id：user_id参数

retrieve_run_usage

• 身份证件: GET-v1-runs-run-id-usage
• 描述：获取跑步的使用统计数据。
• 方法: GET
• 路径: /v1/runs/{run_id}/usage

参数:

• run_id：run_id参数（必需）
• user_id：user_id参数

list_run_steps

• 身份证件: GET-v1-runs-run-id-steps
• 描述：使用筛选选项获取与跑步相关的消息。

Args： run_id：运行的id before：用于分页的光标。 before 是一个对象ID，用于定义您在列表中的位置。例如，如果你发出一个列表请求并收到100个对象，从obj_foo开始，你的后续调用可以包含before=obj_fou，以获取列表的前一页。 after：用于分页的光标。 after 是一个对象ID，用于定义您在列表中的位置。例如，如果你发出一个列表请求并收到100个对象，以obj_foo结尾，你的后续调用可以包含after=obj_fou，以获取列表的下一页。 limit：返回的最大步数 order：按对象的created_at时间戳排序。asc表示升序，desc表示降序。

退货： 与跑步相关的步骤列表。

• 方法: GET
• 路径: /v1/runs/{run_id}/steps

参数:

• run_id：run_id参数（必需）
• before：分页光标
• after：分页光标
• limit：要返回的最大邮件数
• order：按对象的created_at时间戳排序。asc表示升序，desc表示降序。
• user_id：user_id参数

list_steps

• 身份证件: GET-v1-steps
• 描述：列出带有可选分页和日期过滤器的步骤。 日期应采用ISO 8601格式提供（例如2025-01-29T15:01:19-08:00）
• 方法: GET
• 路径: /v1/steps

参数:

• before：返回此步骤ID之前的步骤
• after：返回此步骤ID后的步骤
• limit：返回的最大步骤数
• order：排序顺序（asc或desc）
• start_date：返回此ISO日期时间之后的步骤（例如“2025-01-29T15:0:19-08:00”）
• end_date：返回此ISO日期时间之前的步骤（例如“2025-01-29T15:0:19-08:00”）
• model：按步骤所用模型的名称进行筛选
• agent_id：按执行该步骤的代理的ID进行筛选
• user_id：user_id参数

retrieve_step

• 身份证件: GET-v1-steps-step-id
• 描述：按ID获取步骤。
• 方法: GET
• 路径: /v1/steps/{step_id}

参数:

• step_id：step_id参数（必填）
• user_id：user_id参数

update_step_transaction_id

• 身份证件: PATCH-v1-steps-step-id-transaction-transaction-id
• 描述：更新步骤的事务ID。
• 方法: PATCH
• 路径: /v1/steps/{step_id}/transaction/{transaction_id}

参数:

• step_id：step_id参数（必填）
• transaction_id：transaction_id参数（必需）
• user_id：user_id参数

list_tags

• 身份证件: GET-v1-tags-
• 描述：获取数据库中所有标签的列表
• 方法: GET
• 路径: /v1/tags/

参数:

• after：参数后
• limit：限制参数
• query_text：query_text参数
• user_id：user_id参数

create_voice_chat_完成

• 身份证件: POST-v1-voice-beta-agent-id-chat-completions
• 描述：向/v1/voice beta/{agent_id}/聊天/补全发出POST请求
• 方法: POST
• 路径: /v1/voice-beta/{agent_id}/chat/completions

参数:

• agent_id：agent_id参数（必填）
• user-id：用户id参数

list_users

• 身份证件: GET-v1-admin-users-
• 描述：获取数据库中所有用户的列表
• 方法: GET
• 路径: /v1/admin/users/

参数:

• after：参数后
• limit：限制参数

create_user

• 身份证件: POST-v1-admin-users-
• 描述：在数据库中创建新用户
• 方法: POST
• 路径: /v1/admin/users/

无需参数。

update_user

• 身份证件: PUT-v1-admin-users-
• 描述：更新数据库中的用户
• 方法: PUT
• 路径: /v1/admin/users/

无需参数。

删除用户

• 身份证件: DELETE-v1-admin-users-
• 描述：向/v1/admin/users发出DELETE请求/
• 方法: DELETE
• 路径: /v1/admin/users/

参数:

• user_id：要删除的user_id密钥。（必填）

list_orgs

• 身份证件: GET-v1-admin-orgs-
• 描述：获取数据库中所有组织的列表
• 方法: GET
• 路径: /v1/admin/orgs/

参数:

• after：参数后
• limit：限制参数

创建组织

• 身份证件: POST-v1-admin-orgs-
• 描述：在数据库中创建一个新组织
• 方法: POST
• 路径: /v1/admin/orgs/

无需参数。

删除组织_by_id

• 身份证件: DELETE-v1-admin-orgs-
• 描述：向/v1/admin/ogs发出DELETE请求/
• 方法: DELETE
• 路径: /v1/admin/orgs/

参数:

• org_id：要删除的org_id密钥。（必填）

更新_组织

• 身份证件: PATCH-v1-admin-orgs-
• 描述：向/v1/admin/ogs发出PATCH请求/
• 方法: PATCH
• 路径: /v1/admin/orgs/

参数:

• org_id：要更新的org_id密钥。（必填）

create_chat_完成

• 身份证件: POST-openai-v1-agent-id-chat-completions
• 描述：向/openai/v1/{agent_id}/chat/coompletions发出POST请求
• 方法: POST
• 路径: /openai/v1/{agent_id}/chat/completions

参数:

• agent_id：agent_id参数（必填）
• user-id：用户id参数

authenticate_user_v1_auth_post

• 身份证件: POST-v1-auth
• 描述：对用户进行身份验证，并发送包含用户相关数据的响应。

目前，这是一个占位符，只返回一个UUID占位符

• 方法: POST
• 路径: /v1/auth

无需参数。

许可证

麻省理工学院