openapi-mcp-服务器

Letta API 的模型上下文协议 (MCP) 服务器。

描述

该服务器为 API 提供模型上下文协议 (MCP) 接口。

Related MCP server: agentforge

安装

1. 安装依赖项：

npm install

2. 根据.env.example创建.env文件：

cp .env.example .env

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

配置

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

• API_BASE_URL ：API 的基本 URL（必需）

• SERVER_NAME ：MCP 服务器的名称（默认值：“openapi-mcp-server”）

• 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 服务器提供以下工具：

删除工具

• ID ： DELETE-v1-tools-tool-id

• 描述：按名称删除工具

• 方法： DELETE

• 路径： /v1/tools/{tool_id}

参数：

• tool_id ：tool_id参数（必需）

• user_id ：user_id 参数

检索工具

• ID ： GET-v1-tools-tool-id

• 描述：通过ID获取工具

• 方法： GET

• 路径： /v1/tools/{tool_id}

参数：

• tool_id ：tool_id参数（必需）

• user_id ：user_id 参数

修改工具

• ID ： PATCH-v1-tools-tool-id

• 描述：更新现有工具

• 方法： PATCH

• 路径： /v1/tools/{tool_id}

参数：

• tool_id ：tool_id参数（必需）

• user_id ：user_id 参数

列表工具

• ID ： GET-v1-tools-

• 描述：获取属于用户组织的代理可用的所有工具的列表

• 方法： GET

• 路径： /v1/tools/

参数：

• after ：参数之后

• limit ：限制参数

• name ：名称参数

• user_id ：user_id 参数

创建工具

• ID : POST-v1-tools-

• 描述：创建新工具

• 方法： POST

• 路径： /v1/tools/

参数：

• user_id ：user_id 参数

upsert_工具

• ID ： PUT-v1-tools-

• 描述：创建或更新工具

• 方法： PUT

• 路径： /v1/tools/

参数：

• user_id ：user_id 参数

添加基础工具

• ID ： POST-v1-tools-add-base-tools

• 描述：Upsert 基础工具

• 方法： POST

• 路径： /v1/tools/add-base-tools

参数：

• user_id ：user_id 参数

从源运行工具

• ID : POST-v1-tools-run

• 描述：尝试从源代码构建一个工具，然后根据提供的参数运行它

• 方法： POST

• 路径： /v1/tools/run

参数：

• user_id ：user_id 参数

列表_composio_apps

• ID : GET-v1-tools-composio-apps

• 描述：获取所有 Composio 应用的列表

• 方法： GET

• 路径： /v1/tools/composio/apps

参数：

• user-id ：用户id参数

list_composio_actions_by_app

• ID ： 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 参数

添加组合工具

• ID ： 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 参数

列出mcp服务器

• ID : GET-v1-tools-mcp-servers

• 描述：获取所有已配置的 MCP 服务器列表

• 方法： GET

• 路径： /v1/tools/mcp/servers

参数：

• user-id ：用户id参数

添加mcp服务器

• ID : PUT-v1-tools-mcp-servers

• 描述：向 Letta MCP 服务器配置中添加新的 MCP 服务器

• 方法： PUT

• 路径： /v1/tools/mcp/servers

参数：

• user_id ：user_id 参数

列出mcp_tools_by_server

• ID : 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 参数

添加mcp工具

• ID : 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_tool_name 参数（必需）

• user_id ：user_id 参数

删除_mcp_服务器

• ID : DELETE-v1-tools-mcp-servers-mcp-server-name

• 描述：向 Letta MCP 服务器配置中添加新的 MCP 服务器

• 方法： DELETE

• 路径： /v1/tools/mcp/servers/{mcp_server_name}

参数：

• mcp_server_name ：mcp_server_name 参数（必需）

• user_id ：user_id 参数

检索源

• ID ： GET-v1-sources-source-id

• 描述：获取所有来源

• 方法： GET

• 路径： /v1/sources/{source_id}

参数：

• source_id ：source_id参数（必需）

• user_id ：user_id 参数

修改源

• ID ： PATCH-v1-sources-source-id

• 描述：更新现有数据源的名称或文档。

• 方法： PATCH

• 路径： /v1/sources/{source_id}

参数：

• source_id ：source_id参数（必需）

• user_id ：user_id 参数

删除源

• ID ： DELETE-v1-sources-source-id

• 描述：删除数据源。

• 方法： DELETE

• 路径： /v1/sources/{source_id}

参数：

• source_id ：source_id参数（必需）

• user_id ：user_id 参数

通过名称获取源 ID

• ID ： GET-v1-sources-name-source-name

• 描述：通过名称获取源

• 方法： GET

• 路径： /v1/sources/name/{source_name}

参数：

• source_name ：source_name 参数（必需）

• user_id ：user_id 参数

列表来源

• ID ： GET-v1-sources-

• 描述：列出用户创建的所有数据源。

• 方法： GET

• 路径： /v1/sources/

参数：

• user_id ：user_id 参数

创建源

• ID ： POST-v1-sources-

• 描述：创建一个新的数据源。

• 方法： POST

• 路径： /v1/sources/

参数：

• user_id ：user_id 参数

upload_file_to_source

• ID ： POST-v1-sources-source-id-upload

• 描述：将文件上传到数据源。

• 方法： POST

• 路径： /v1/sources/{source_id}/upload

参数：

• source_id ：source_id参数（必需）

• user_id ：user_id 参数

列出来源段落

• ID ： GET-v1-sources-source-id-passages

• 描述：列出与数据源相关的所有段落。

• 方法： GET

• 路径： /v1/sources/{source_id}/passages

参数：

• source_id ：source_id参数（必需）

• user_id ：user_id 参数

列出源文件

• ID ： GET-v1-sources-source-id-files

• 描述：列出与数据源相关的分页文件。

• 方法： GET

• 路径： /v1/sources/{source_id}/files

参数：

• source_id ：source_id参数（必需）

• limit ：返回的文件数量

• after ：分页游标，用于获取下一组结果

• user_id ：user_id 参数

从源中删除文件

• ID ： 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 参数

列表代理

• 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 参数

创建代理

• ID ： POST-v1-agents-

• 描述：使用指定的配置创建一个新的代理。

• 方法： POST

• 路径： /v1/agents/

参数：

• user_id ：user_id 参数

• X-Project ：X-Project 参数

导出_代理_序列化

• ID ： GET-v1-agents-agent-id-export

• 描述：导出代理的序列化 JSON 表示。

• 方法： GET

• 路径： /v1/agents/{agent_id}/export

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

导入代理序列化

• 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 参数

检索代理上下文窗口

• ID ： GET-v1-agents-agent-id-context

• 描述：检索特定代理的上下文窗口。

• 方法： GET

• 路径： /v1/agents/{agent_id}/context

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

修改代理

• ID ： PATCH-v1-agents-agent-id

• 描述：更新现有代理

• 方法： PATCH

• 路径： /v1/agents/{agent_id}

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

检索代理

• ID ： GET-v1-agents-agent-id

• 描述：获取代理的状态。

• 方法： GET

• 路径： /v1/agents/{agent_id}

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

删除代理

• ID ： DELETE-v1-agents-agent-id

• 描述：删除代理。

• 方法： DELETE

• 路径： /v1/agents/{agent_id}

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

列表代理工具

• ID ： GET-v1-agents-agent-id-tools

• 描述：从现有代理获取工具

• 方法： GET

• 路径： /v1/agents/{agent_id}/tools

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

附加工具

• 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 参数

分离工具

• ID ： 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 参数

将源连接到代理

• 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 参数

分离源与代理

• 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 参数

列出代理源

• ID ： GET-v1-agents-agent-id-sources

• 描述：获取与代理相关的来源。

• 方法： GET

• 路径： /v1/agents/{agent_id}/sources

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

检索代理内存

• ID ： GET-v1-agents-agent-id-core-memory

• 描述：检索特定代理的内存状态。此端点获取由用户 ID 和代理 ID 标识的代理的当前内存状态。

• 方法： GET

• 路径： /v1/agents/{agent_id}/core-memory

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

检索核心内存块

• ID ： 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 参数

修改核心内存块

• ID ： 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 参数

列出核心内存块

• ID ： GET-v1-agents-agent-id-core-memory-blocks

• 描述：检索特定代理的核心内存块。

• 方法： GET

• 路径： /v1/agents/{agent_id}/core-memory/blocks

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

附加核心内存块

• 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 参数

分离核心内存块

• ID ： 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 参数

列出段落

• 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 参数

创建通道

• ID ： POST-v1-agents-agent-id-archival-memory

• 描述：将记忆插入代理的档案记忆库。

• 方法： POST

• 路径： /v1/agents/{agent_id}/archival-memory

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

修改段落

• 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 参数

删除段落

• 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 参数

列表消息

• ID ： 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 参数

发送消息

• ID ： POST-v1-agents-agent-id-messages

• 描述：处理用户消息并返回代理的响应。此端点接受来自用户的消息并通过代理进行处理。

• 方法： POST

• 路径： /v1/agents/{agent_id}/messages

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

修改消息

• 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 参数

创建代理消息流

• ID ： 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 参数

创建代理消息异步

• ID ： POST-v1-agents-agent-id-messages-async

• 描述：异步处理用户消息并返回一个运行对象。实际处理在后台进行，可以使用运行 ID 检查状态。

• 方法： POST

• 路径： /v1/agents/{agent_id}/messages/async

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

重置消息

• ID ： PATCH-v1-agents-agent-id-reset-messages

• 描述：重置代理的消息

• 方法： PATCH

• 路径： /v1/agents/{agent_id}/reset-messages

参数：

• agent_id ：agent_id参数（必需）

• add_default_initial_messages ：如果为真，则重置后添加默认初始消息。

• user_id ：user_id 参数

创建组

• ID ： POST-v1-groups-

• 描述：使用指定的配置创建一个新的多代理组。

• 方法： POST

• 路径： /v1/groups/

参数：

• user_id ：user_id 参数

• X-Project ：X-Project 参数

列表组

• ID ： GET-v1-groups-

• 描述：获取所有符合查询的多代理组。

• 方法： GET

• 路径： /v1/groups/

参数：

• manager_type ：按经理类型搜索群组

• before ：分页光标

• after ：分页光标

• limit ：分页限制

• project_id ：按项目 ID 搜索组

• user_id ：user_id 参数

upsert_group

• ID ： PUT-v1-groups-

• 描述：使用指定的配置创建一个新的多代理组。

• 方法： PUT

• 路径： /v1/groups/

参数：

• user_id ：user_id 参数

• X-Project ：X-Project 参数

删除组

• ID ： DELETE-v1-groups-group-id

• 描述：删除多代理组。

• 方法： DELETE

• 路径： /v1/groups/{group_id}

参数：

• group_id ：group_id参数（必需）

• user_id ：user_id 参数

发送群组消息

• ID ： POST-v1-groups-group-id-messages

• 描述：处理用户消息并返回群组响应。此端点接收来自用户的消息，并根据指定的模式将其传递给群组中的代理进行处理。

• 方法： POST

• 路径： /v1/groups/{group_id}/messages

参数：

• agent_id ：agent_id参数（必需）

• user_id ：user_id 参数

列出群组消息

• ID ： 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 参数

发送群组消息流

• ID ： 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 参数

列表_身份

• ID ： GET-v1-identities-

• 描述：获取数据库中所有身份的列表

• 方法： GET

• 路径： /v1/identities/

参数：

• name ：名称参数

• project_id ：project_id 参数

• identifier_key ：identifier_key 参数

• identity_type ：identity_type 参数

• before ：参数之前

• after ：参数之后

• limit ：限制参数

• user_id ：user_id 参数

创建身份

• ID ： POST-v1-identities-

• 描述：向 /v1/identities/ 发出 POST 请求

• 方法： POST

• 路径： /v1/identities/

参数：

• user_id ：user_id 参数

• X-Project ：X-Project 参数

upsert_identity

• ID ： PUT-v1-identities-

• 描述：向 /v1/identities/ 发出 PUT 请求

• 方法： PUT

• 路径： /v1/identities/

参数：

• user_id ：user_id 参数

• X-Project ：X-Project 参数

检索_身份

• ID ： GET-v1-identities-identity-id

• 描述：向 /v1/identities/{identity_id} 发出 GET 请求

• 方法： GET

• 路径： /v1/identities/{identity_id}

参数：

• identity_id ：identity_id参数（必需）

• user_id ：user_id 参数

更新身份

• ID ： PATCH-v1-identities-identity-id

• 描述：向 /v1/identities/{identity_id} 发出 PATCH 请求

• 方法： PATCH

• 路径： /v1/identities/{identity_id}

参数：

• identity_id ：identity_id参数（必需）

• user_id ：user_id 参数

删除身份

• ID ： DELETE-v1-identities-identity-id

• 描述：通过标识符键删除身份

• 方法： DELETE

• 路径： /v1/identities/{identity_id}

参数：

• identity_id ：identity_id参数（必需）

• user_id ：user_id 参数

列表模型

• ID ： GET-v1-models-

• 描述：向 /v1/models/ 发出 GET 请求

• 方法： GET

• 路径： /v1/models/

无需任何参数。

列表嵌入模型

• ID ： GET-v1-models-embedding

• 描述：向 /v1/models/embedding 发出 GET 请求

• 方法： GET

• 路径： /v1/models/embedding

无需任何参数。

列表块

• ID : GET-v1-blocks-

• 描述：向 /v1/blocks/ 发出 GET 请求

• 方法： GET

• 路径： /v1/blocks/

参数：

• label ：要包含的标签（例如，人类、人物）

• templates_only ：是否仅包含模板

• name ：块的名称

• identity_id ：通过标识符 id 搜索代理

• identifier_keys ：通过标识符键搜索代理

• user_id ：user_id 参数

创建块

• ID ： POST-v1-blocks-

• 描述：向 /v1/blocks/ 发出 POST 请求

• 方法： POST

• 路径： /v1/blocks/

参数：

• user_id ：user_id 参数

修改块

• ID ： PATCH-v1-blocks-block-id

• 描述：向 /v1/blocks/{block_id} 发出 PATCH 请求

• 方法： PATCH

• 路径： /v1/blocks/{block_id}

参数：

• block_id ：block_id参数（必需）

• user_id ：user_id 参数

删除块

• ID ： DELETE-v1-blocks-block-id

• 描述：向 /v1/blocks/{block_id} 发出 DELETE 请求

• 方法： DELETE

• 路径： /v1/blocks/{block_id}

参数：

• block_id ：block_id参数（必需）

• user_id ：user_id 参数

检索块

• ID ： GET-v1-blocks-block-id

• 描述：向 /v1/blocks/{block_id} 发出 GET 请求

• 方法： GET

• 路径： /v1/blocks/{block_id}

参数：

• block_id ：block_id参数（必需）

• user_id ：user_id 参数

列出代理以阻止

• ID ： GET-v1-blocks-block-id-agents

• 描述：检索与指定块关联的所有代理。如果该块不存在，则抛出 404 错误。

• 方法： GET

• 路径： /v1/blocks/{block_id}/agents

参数：

• block_id ：block_id参数（必需）

• user_id ：user_id 参数

列出工作

• ID ： GET-v1-jobs-

• 描述：列出所有工作。

• 方法： GET

• 路径： /v1/jobs/

参数：

• source_id ：仅列出与源相关的作业。

• user_id ：user_id 参数

列出活跃工作

• ID : GET-v1-jobs-active

• 描述：列出所有活跃的作业。

• 方法： GET

• 路径： /v1/jobs/active

参数：

• user_id ：user_id 参数

检索作业

• ID ： GET-v1-jobs-job-id

• 描述：获取作业的状态。

• 方法： GET

• 路径： /v1/jobs/{job_id}

参数：

• job_id ：job_id参数（必需）

• user_id ：user_id 参数

删除作业

• ID ： DELETE-v1-jobs-job-id

• 描述：通过 job_id 删除作业。

• 方法： DELETE

• 路径： /v1/jobs/{job_id}

参数：

• job_id ：job_id参数（必需）

• user_id ：user_id 参数

健康检查

• ID : GET-v1-health-

• 描述：向 /v1/health/ 发出 GET 请求

• 方法： GET

• 路径： /v1/health/

无需任何参数。

创建沙盒配置_v1_sandbox_config__post

• ID ： POST-v1-sandbox-config-

• 描述：向 /v1/sandbox-config/ 发出 POST 请求

• 方法： POST

• 路径： /v1/sandbox-config/

参数：

• user-id ：用户id参数

list_sandbox_configs_v1_sandbox_config__get

• ID ： GET-v1-sandbox-config-

• 描述：向 /v1/sandbox-config/ 发出 GET 请求

• 方法： GET

• 路径： /v1/sandbox-config/

参数：

• limit ：返回的结果数

• after ：分页游标，用于获取下一组结果

• sandbox_type ：此特定沙盒类型的过滤器

• user-id ：用户id参数

创建默认的e2b_sandbox_config_v1_sandbox_config_e2b_default_post

• ID ： POST-v1-sandbox-config-e2b-default

• 描述：向 /v1/sandbox-config/e2b/default 发出 POST 请求

• 方法： POST

• 路径： /v1/sandbox-config/e2b/default

参数：

• user-id ：用户id参数

创建默认本地沙盒配置

• ID ： POST-v1-sandbox-config-local-default

• 描述：向 /v1/sandbox-config/local/default 发出 POST 请求

• 方法： POST

• 路径： /v1/sandbox-config/local/default

参数：

• user-id ：用户id参数

创建自定义本地沙盒配置v1沙盒配置本地帖子

• ID ： POST-v1-sandbox-config-local

• 描述：创建或更新自定义 LocalSandboxConfig，包括 pip_requirements。

• 方法： POST

• 路径： /v1/sandbox-config/local

参数：

• user-id ：用户id参数

更新沙盒配置_v1_sandbox_config__sandbox_config_id__patch

• ID ： 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参数

删除_sandbox_config_v1_sandbox_config__sandbox_config_id__delete

• ID ： 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_config_local_recreate_venv_post

• ID ： POST-v1-sandbox-config-local-recreate-venv

• 描述：强制为本地沙盒重新创建虚拟环境。删除并重新创建 venv，然后重新安装所需的依赖项。

• 方法： POST

• 路径： /v1/sandbox-config/local/recreate-venv

参数：

• user-id ：用户id参数

创建沙盒环境变量

• ID ： POST-v1-sandbox-config-sandbox-config-id-environment-variable

• 描述：向 /v1/sandbox-config/{sandbox_config_id}/environment-variable 发出 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__sandbox_config_id__environment_variable_get

• ID ： GET-v1-sandbox-config-sandbox-config-id-environment-variable

• 描述：向 /v1/sandbox-config/{sandbox_config_id}/environment-variable 发出 GET 请求

• 方法： GET

• 路径： /v1/sandbox-config/{sandbox_config_id}/environment-variable

参数：

• sandbox_config_id ：sandbox_config_id 参数（必需）

• limit ：返回的结果数

• after ：分页游标，用于获取下一组结果

• user-id ：用户id参数

更新沙盒环境变量

• ID ： PATCH-v1-sandbox-config-environment-variable-env-var-id

• 描述：向 /v1/sandbox-config/environment-variable/{env_var_id} 发出 PATCH 请求

• 方法： PATCH

• 路径： /v1/sandbox-config/environment-variable/{env_var_id}

参数：

• env_var_id ：env_var_id 参数（必需）

• user-id ：用户id参数

删除_sandbox_env_var_v1_sandbox_config_environment_variable__env_var_id__delete

• ID ： DELETE-v1-sandbox-config-environment-variable-env-var-id

• 描述：向 /v1/sandbox-config/environment-variable/{env_var_id} 发出 DELETE 请求

• 方法： DELETE

• 路径： /v1/sandbox-config/environment-variable/{env_var_id}

参数：

• env_var_id ：env_var_id 参数（必需）

• user-id ：用户id参数

列表提供者

• ID ： GET-v1-providers-

• 描述：获取数据库中所有自定义提供商的列表

• 方法： GET

• 路径： /v1/providers/

参数：

• after ：参数之后

• limit ：限制参数

• user_id ：user_id 参数

创建提供者

• ID ： POST-v1-providers-

• 描述：创建一个新的自定义提供程序

• 方法： POST

• 路径： /v1/providers/

参数：

• user_id ：user_id 参数

修改提供者

• ID ： PATCH-v1-providers-

• 描述：更新现有的自定义提供程序

• 方法： PATCH

• 路径： /v1/providers/

参数：

• user_id ：user_id 参数

删除提供者

• ID ： DELETE-v1-providers-

• 描述：删除现有的自定义提供程序

• 方法： DELETE

• 路径： /v1/providers/

参数：

• provider_id ：要删除的 provider_id 键。（必需）

• user_id ：user_id 参数

列表运行

• ID ： GET-v1-runs-

• 描述：列出所有运行。

• 方法： GET

• 路径： /v1/runs/

参数：

• user_id ：user_id 参数

列出活动运行

• ID : GET-v1-runs-active

• 描述：列出所有活动运行。

• 方法： GET

• 路径： /v1/runs/active

参数：

• user_id ：user_id 参数

检索运行

• ID ： GET-v1-runs-run-id

• 描述：获取运行状态。

• 方法： GET

• 路径： /v1/runs/{run_id}

参数：

• run_id ：run_id参数（必需）

• user_id ：user_id 参数

删除运行

• ID ： DELETE-v1-runs-run-id

• 描述：通过 run_id 删除运行。

• 方法： DELETE

• 路径： /v1/runs/{run_id}

参数：

• run_id ：run_id参数（必需）

• user_id ：user_id 参数

列出运行消息

• ID ： GET-v1-runs-run-id-messages

• 描述：通过过滤选项获取与运行相关的消息。

参数：run_id：运行的 ID before ：用于分页的游标。before 是定义您在列表中位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 开头，则后续调用可以包含 before=obj_foo 以获取列表的上一页。after：用于分页的游标。after after定义您在列表中位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 结尾，则后续调用可以包含 after=obj_foo 以获取列表的下一页。limit：要返回的最大消息数 order：按对象的 created_at 时间戳排序。asc 表示升序，desc 表示降序。role：按角色（用户/助理/系统/工具）过滤 return_message_object：是否返回 Message 对象或 LettaMessage 对象 user_id：发出请求的用户 ID

返回：与运行相关的消息列表。默认值为 List[LettaMessage]。

• 方法： GET

• 路径： /v1/runs/{run_id}/messages

参数：

• run_id ：run_id参数（必需）

• before ：分页光标

• after ：分页光标

• limit ：返回的最大消息数

• order ：按对象的 created_at 时间戳排序。asc 表示升序，desc 表示降序。

• role ：按角色过滤

• user_id ：user_id 参数

检索运行使用情况

• ID ： GET-v1-runs-run-id-usage

• 描述：获取运行的使用情况统计数据。

• 方法： GET

• 路径： /v1/runs/{run_id}/usage

参数：

• run_id ：run_id参数（必需）

• user_id ：user_id 参数

列出跑步步骤

• ID ： GET-v1-runs-run-id-steps

• 描述：通过过滤选项获取与运行相关的消息。

参数： run_id：运行的 ID before：分页使用的游标。 before是定义您在列表中位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 开头，则后续调用可以包含 before=obj_foo 以获取列表的上一页。 after：分页使用的游标。 after是定义您在列表中位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 结尾，则后续调用可以包含 after=obj_foo 以获取列表的下一页。 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 参数

列表步骤

• ID ： GET-v1-steps

• 描述：列出步骤，并可选配分页和日期筛选器。日期应采用 ISO 8601 格式（例如 2025-01-29T15:01:19-08:00）。

• 方法： GET

• 路径： /v1/steps

参数：

• before ：返回此步骤 ID 之前的步骤

• after ：返回此步骤 ID 之后的步骤

• limit ：返回的最大步数

• order ：排序顺序（升序或降序）

• start_date ：返回此 ISO 日期时间之后的步骤（例如“2025-01-29T15：01：19-08：00”）

• end_date ：返回此 ISO 日期时间之前的步骤（例如“2025-01-29T15：01：19-08：00”）

• model ：按步骤使用的模型名称进行过滤

• agent_id ：按执行该步骤的代理的 ID 进行过滤

• user_id ：user_id 参数

检索步骤

• ID ： GET-v1-steps-step-id

• 描述：通过 ID 获取步骤。

• 方法： GET

• 路径： /v1/steps/{step_id}

参数：

• step_id ：step_id参数（必需）

• user_id ：user_id 参数

更新步骤事务 ID

• 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 参数

列表标签

• ID ： GET-v1-tags-

• 描述：获取数据库中所有标签的列表

• 方法： GET

• 路径： /v1/tags/

参数：

• after ：参数之后

• limit ：限制参数

• query_text ：query_text 参数

• user_id ：user_id 参数

创建语音聊天完成

• ID ： POST-v1-voice-beta-agent-id-chat-completions

• 描述：向 /v1/voice-beta/{agent_id}/chat/completions 发出 POST 请求

• 方法： POST

• 路径： /v1/voice-beta/{agent_id}/chat/completions

参数：

• agent_id ：agent_id参数（必需）

• user-id ：用户id参数

列出用户

• ID ： GET-v1-admin-users-

• 描述：获取数据库中所有用户的列表

• 方法： GET

• 路径： /v1/admin/users/

参数：

• after ：参数之后

• limit ：限制参数

创建用户

• ID ： POST-v1-admin-users-

• 描述：在数据库中创建新用户

• 方法： POST

• 路径： /v1/admin/users/

无需任何参数。

更新用户

• ID ： PUT-v1-admin-users-

• 描述：更新数据库中的用户

• 方法： PUT

• 路径： /v1/admin/users/

无需任何参数。

删除用户

• ID ： DELETE-v1-admin-users-

• 描述：向 /v1/admin/users/ 发出 DELETE 请求

• 方法： DELETE

• 路径： /v1/admin/users/

参数：

• user_id ：要删除的 user_id 键。（必需）

列表组织

• ID ： GET-v1-admin-orgs-

• 描述：获取数据库中所有组织的列表

• 方法： GET

• 路径： /v1/admin/orgs/

参数：

• after ：参数之后

• limit ：限制参数

创建组织

• ID ： POST-v1-admin-orgs-

• 描述：在数据库中创建一个新的组织

• 方法： POST

• 路径： /v1/admin/orgs/

无需任何参数。

删除组织_按_id

• ID ： DELETE-v1-admin-orgs-

• 描述：向 /v1/admin/orgs/ 发出 DELETE 请求

• 方法： DELETE

• 路径： /v1/admin/orgs/

参数：

• org_id ：要删除的 org_id 键。（必需）

更新组织

• ID ： PATCH-v1-admin-orgs-

• 描述：向 /v1/admin/orgs/ 发出 PATCH 请求

• 方法： PATCH

• 路径： /v1/admin/orgs/

参数：

• org_id ：要更新的 org_id 键。（必需）

创建聊天完成

• ID ： POST-openai-v1-agent-id-chat-completions

• 描述：向 /openai/v1/{agent_id}/chat/completions 发出 POST 请求

• 方法： POST

• 路径： /openai/v1/{agent_id}/chat/completions

参数：

• agent_id ：agent_id参数（必需）

• user-id ：用户id参数

验证用户身份_v1_auth_post

• ID : POST-v1-auth

• 描述：验证用户并发送与用户相关的数据的响应。

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

• 方法： POST

• 路径： /v1/auth

无需任何参数。

执照

麻省理工学院