OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

Gateway

工具呼叫 API

OpenClaw 的閘道提供一個 HTTP 端點，可直接叫用單一工具。此端點一律啟用，並使用閘道驗證與工具政策。與 OpenAI 相容的 /v1/* 介面相同，共用密鑰的 Bearer 驗證會被視為對整個閘道具有受信任的操作者存取權。

  • POST /tools/invoke
  • 與閘道使用相同連接埠（WS + HTTP 多工）：http://<gateway-host>:<port>/tools/invoke
  • 預設要求主體大小上限：2 MB

驗證

使用閘道驗證設定。

常見的 HTTP 驗證路徑：

  • 共用密鑰驗證（gateway.auth.mode="token" 或 "password"）：Authorization: Bearer <token-or-password>
  • 攜帶受信任身分的 HTTP 驗證（gateway.auth.mode="trusted-proxy"）：透過已設定的身分識別感知 Proxy 路由，並由它注入必要的身分標頭
  • 私有入口開放驗證（gateway.auth.mode="none"）：不需要驗證標頭

注意事項：

  • mode="token" 使用 gateway.auth.token（或 OPENCLAW_GATEWAY_TOKEN）。
  • mode="password" 使用 gateway.auth.password（或 OPENCLAW_GATEWAY_PASSWORD）。
  • mode="trusted-proxy" 要求 HTTP 請求來自已設定的受信任 Proxy 來源；同一主機上的迴路 Proxy 需要明確設定 gateway.auth.trustedProxy.allowLoopback = true。
  • 繞過 Proxy 的同一主機內部呼叫端，可以使用 gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD 作為本機直接備援。任何 Forwarded、X-Forwarded-* 或 X-Real-IP 標頭證據，則會讓請求繼續走受信任 Proxy 路徑。
  • 如果已設定 gateway.auth.rateLimit，且發生過多次驗證失敗，端點會傳回 429，並附帶 Retry-After。

安全性邊界（重要）

請將此端點視為閘道執行個體的完整操作者存取權介面。

  • 此處的 HTTP Bearer 驗證不是狹義的每位使用者範圍模型。
  • 此端點的有效閘道權杖／密碼應被視為擁有者／操作者認證資訊。
  • 對於共用密鑰驗證模式（token 和 password），即使呼叫端傳送範圍較窄的 x-openclaw-scopes 標頭，此端點仍會還原一般的完整操作者預設值。
  • 共用密鑰驗證也會將此端點上的直接工具叫用視為擁有者傳送者回合。
  • 攜帶受信任身分的 HTTP 模式（受信任 Proxy 驗證，或私有入口上的 gateway.auth.mode="none"）會採用存在的 x-openclaw-scopes，否則回退到一般操作者預設範圍集。
  • 此端點應僅限於迴路／Tailnet／私有入口；請勿直接公開至公用網際網路。

驗證矩陣：

驗證模式 行為
token 或 password + Authorization: Bearer ... 證明持有共用的閘道操作者密鑰。忽略範圍較窄的 x-openclaw-scopes。還原完整的預設操作者範圍集：operator.admin、operator.approvals、operator.pairing、operator.read、operator.talk.secrets、operator.write。將直接工具叫用視為擁有者傳送者回合。
攜帶受信任身分的 HTTP（受信任 Proxy 驗證，或私有入口上的 mode="none"） 驗證外層受信任身分或部署邊界。採用存在的 x-openclaw-scopes。標頭不存在時，回退到一般操作者預設範圍集。只有在呼叫端明確縮小範圍並省略 operator.admin 時，才會失去擁有者語意。

要求主體

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

欄位：

  • tool / name（字串，必填）：要叫用的工具名稱。如果兩者皆有傳送，則以 name 為優先。
  • action（字串，選填）：如果工具結構描述支援 action 屬性，且 args 尚未設定該屬性，則會合併至 args.action。
  • args（物件，選填）：工具專屬引數。
  • sessionKey（字串，選填）：目標工作階段金鑰。如果省略或為 "main"，閘道會使用已設定的主要工作階段金鑰（採用 session.mainKey 和預設代理程式，或在全域工作階段範圍中使用 global）。
  • agentId（字串，選填）：解析該代理程式的工作階段金鑰。如果它與已明確指定且對應至其他代理程式的 sessionKey 衝突，則傳回 400 錯誤。
  • idempotencyKey（字串，選填）：用於為叫用衍生穩定的工具呼叫 ID。
  • dryRun（布林值，選填）：保留供未來使用；目前會忽略。

政策與路由行為

工具可用性會經過與閘道代理程式相同的政策鏈篩選：

  • tools.profile / tools.byProvider.profile
  • tools.allow / tools.byProvider.allow
  • agents.<id>.tools.allow / agents.<id>.tools.byProvider.allow
  • 群組政策（如果工作階段金鑰對應至群組或頻道）
  • 子代理程式政策（使用子代理程式工作階段金鑰叫用時）

如果政策不允許某個工具，端點會傳回 404。

重要邊界注意事項：

  • 執行核准是操作者防護措施，並非此 HTTP 端點的獨立授權邊界。如果可透過閘道驗證與工具政策存取此處的工具，/tools/invoke 不會另外加入每次呼叫的核准提示。
  • 如果可在此處存取 exec，請將其視為會修改內容的 Shell 介面。拒絕 write、edit、apply_patch 或 HTTP 檔案系統寫入工具，不會使 Shell 執行變成唯讀。
  • 請勿與不受信任的呼叫端共用閘道 Bearer 認證資訊。如果需要跨信任邊界隔離，請執行不同的閘道（最好使用不同的作業系統使用者／主機）。

即使工作階段政策允許某工具，閘道 HTTP 預設仍會套用強制拒絕清單：

工具 原因
exec 直接執行命令（RCE 介面）
spawn 任意建立子程序（RCE 介面）
shell 執行 Shell 命令（RCE 介面）
fs_write 任意修改主機上的檔案
fs_delete 任意刪除主機上的檔案
fs_move 任意移動／重新命名主機上的檔案
apply_patch 套用修補程式可能會重寫任意檔案
sessions_spawn 工作階段協調；遠端產生代理程式屬於 RCE
sessions_send 跨工作階段訊息注入
cron 持續性自動化控制平面
gateway 閘道控制平面；防止透過 HTTP 重新設定
nodes 節點命令轉送可存取已配對主機上的 system.run

cron、gateway 和 nodes 也僅限擁有者：即使不在此預設拒絕清單中，非擁有者呼叫端仍無法在此介面叫用它們。

透過 gateway.tools 自訂一般拒絕清單：

json5
{  gateway: {    tools: {      // 要透過 HTTP /tools/invoke 封鎖的其他工具      deny: ["browser"],      // 為擁有者／管理員呼叫端從預設拒絕清單移除工具      allow: ["gateway"],    },  },}

gateway.tools.allow 是公開範圍覆寫，而非範圍升級。在攜帶身分的 HTTP 模式中，即使 cron、gateway 和 nodes 列於 gateway.tools.allow，不具擁有者／管理員身分（operator.admin）的呼叫端仍無法使用它們。共用密鑰 Bearer 驗證仍遵循上述完整受信任操作者規則。

為協助群組政策解析內容，你可以選擇性設定：

  • x-openclaw-message-channel: <channel>（例如：slack、telegram）
  • x-openclaw-account-id: <accountId>（存在多個帳戶時）
  • x-openclaw-message-to: <target>（訊息工具政策的傳遞目標）
  • x-openclaw-thread-id: <threadId>（訊息工具政策的討論串內容）

回應

狀態 含義
200 { ok: true, result }
400 { ok: false, error: { type, message } }（無效要求或工具輸入錯誤）
401 未經驗證
403 { ok: false, error: { type, message, requiresApproval? } }（工具呼叫遭政策封鎖）
404 工具無法使用（找不到或不在允許清單中）
405 不允許的方法
408 讀取要求主體逾時
413 要求主體超過承載資料大小上限
429 驗證受速率限制（已設定 Retry-After）
500 { ok: false, error: { type, message } }（非預期的工具執行錯誤；已清理訊息）

範例

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

相關內容

Was this useful?
On this page

On this page