协议与 API

工具调用 API

OpenClaw 网关提供了一个简单的 HTTP 端点，用于直接调用单个工具。该端点始终启用，但受网关认证和工具策略保护。

POST /tools/invoke
使用与网关相同的端口（WebSocket + HTTP 复用）：http://<gateway-host>:<port>/tools/invoke

默认最大请求体大小为 2 MB。

认证

使用网关的认证配置。请求时需携带 Bearer 令牌：

Authorization: Bearer <token>

注意事项：

当 gateway.auth.mode="token" 时，使用 gateway.auth.token（或环境变量 OPENCLAW_GATEWAY_TOKEN）。
当 gateway.auth.mode="password" 时，使用 gateway.auth.password（或环境变量 OPENCLAW_GATEWAY_PASSWORD）。
如果配置了 gateway.auth.rateLimit 且认证失败次数过多，端点会返回 429 并附带 Retry-After 响应头。

请求体

{
  "tool": "sessions_list",
  "action": "json",
  "args": {},
  "sessionKey": "main",
  "dryRun": false
}

字段说明：

tool（字符串，必填）：要调用的工具名称。
action（字符串，可选）：如果工具 schema 支持 action 参数且 args 中未提供，则映射到 args 中。
args（对象，可选）：工具特定的参数。
sessionKey（字符串，可选）：目标会话键。如果省略或为 "main"，网关会使用配置的主会话键（遵循 session.mainKey 和默认智能体，或在全局作用域下使用 global）。
dryRun（布尔值，可选）：保留供将来使用；目前被忽略。

策略与路由行为

工具的可用性会经过与网关智能体相同的策略链过滤：

tools.profile / tools.byProvider.profile
tools.allow / tools.byProvider.allow
agents.<id>.tools.allow / agents.<id>.tools.byProvider.allow
群组策略（当会话键映射到群组或频道时）
子智能体策略（当使用子智能体会话键调用时）

如果策略不允许某个工具，端点会返回 404。网关 HTTP 还会默认应用一个硬性拒绝列表（即使会话策略允许）：

sessions_spawn
sessions_send
gateway
whatsapp_login

你可以通过 gateway.tools 自定义这个拒绝列表：

{
  gateway: {
    tools: {
      // 通过 HTTP /tools/invoke 额外禁止的工具
      deny: ["browser"],
      // 从默认拒绝列表中移除的工具
      allow: ["gateway"],
    },
  },
}

为帮助群组策略解析上下文，你可以选择性设置以下请求头：

x-openclaw-message-channel: <channel>（例如：slack、telegram）
x-openclaw-account-id: <accountId>（当存在多个账号时）

响应

200 → { ok: true, result }
400 → { ok: false, error: { type, message } }（请求无效或工具输入错误）
401 → 未授权
429 → 认证被限流（设置了 Retry-After）
404 → 工具不可用（未找到或不在允许列表中）
405 → 方法不允许
500 → { ok: false, error: { type, message } }（意外的工具执行错误；消息已脱敏）

示例

curl -sS http://127.0.0.1:18789/tools/invoke \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "tool": "sessions_list",
    "action": "json",
    "args": {}
  }'

OpenResponses API CLI 后端