Gateway 协议
Gateway WS 协议是 OpenClaw 唯一的控制平面和节点传输。Operator 和节点客户端(CLI、web UI、macOS 应用、iOS/Android 节点、无头节点)通过 WebSocket 连接,并在握手时声明 role 和 scope。
在 Gateway 内部运行的 Agent 工具直接通过该 Gateway 的路由器分发请求。它们保留方法作用域、Agent 和审批权限、请求截止时间以及取消能力,而无需打开另一个 WebSocket。显式的 Gateway URL 或 token 覆盖、独立 Agent 以及单独的客户端进程继续使用 WebSocket 传输。
范围¶
该协议暴露完整的 Gateway API:status、channels、models、chat、agent、sessions、nodes、approvals 等。确切接口由从 packages/gateway-protocol/src/schema.ts 重新导出的 TypeBox schema 定义。
各页面涵盖内容¶
- 传输与帧结构 — Gateway WS 传输:数据包、帧结构、限制以及 WebRTC Talk 控制。
- 握手与角色 — connect 帧、hello-ok 负载、客户端能力、角色和作用域。
- 在线状态与事件 — presence 快照、节点主机统计以及广播事件作用域。
- RPC 方法 — RPC 方法族、发现、会话列表引导以及事件族。
- Ledger RPC — 审计 ledger RPC、其作用域、游标和负载。
- Operator 方法 — Operator 辅助方法、exec 审批以及 Agent 投递回退。
- 版本控制 — 协议版本常量、N-1 节点窗口以及客户端默认值。
- 认证与设备身份 — 握手认证路径、设备身份、配对签名以及 TLS 固定。
各章节迁移位置¶
先前单页版本中的每个章节标题都在此处保留其锚点,因此带有片段的现有指向本页面的链接仍可解析。每个条目指向当前承载该内容的页面。
- npm 包
- 传输与帧结构
- Gateway 控制的 WebRTC Talk
- 握手
- Worker 角色与封闭协议
- 客户端能力
- 节点连接示例
- 角色与作用域
- Caps/commands/permissions (node)
- Caps/commands/permissions (node)
- 在线状态
- 节点主机统计
- 节点后台存活事件
- 广播事件作用域
- RPC 方法族
- 系统与身份
- 模型与用量
- 频道与登录辅助
- 插件管理
- 消息与日志
- Operator 终端
- Talk 与 TTS
- Secrets、config、update 和 wizard
- Agent 与工作区辅助
- 会话控制
- 设备配对与设备 token
- 节点配对、invoke 和待处理工作
- 审批族
- Control UI 命令
- 自动化、skills 和 tools
- 会话列表引导
- 常见事件族
- 节点辅助方法
- 节点 exec 生命周期事件
- 审计 ledger RPC
- Operator 辅助方法
models.list视图models.list视图- exec 审批
- Agent 投递回退
- 版本控制
- 客户端常量
- 认证
- 设备身份与配对
- 设备认证迁移诊断
- TLS 与固定
相关¶
- 构建 Gateway 客户端
- 嵌入 OpenClaw
- Gateway 运行手册
- 操作员作用域 — 作用域协议方法所针对的授权范围
- 审计历史 — 仅包含元数据的操作历史和决策回执
- 配对 — 批准谁可以向你发送私信以及哪些节点可以加入
- Cloud Workers — 通过此协议驱动的 worker 会话
- Tools invoke API — 通过 Gateway HTTP 端点直接调用单个工具
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw