Skip to main content
外部应用通过 Gateway 网关协议与 OpenClaw 通信：WebSocket 传输加 RPC 方法。当脚本、仪表板、CI 任务、IDE 扩展或其他进程需要启动智能体运行、流式传输事件、等待结果、取消工作或检查 Gateway 网关资源时，请使用它。
目前还没有公开的 npm 客户端包。在发布说明宣布已发布的包，并且本页包含安装说明之前，不要将 OpenClaw 客户端包名称添加为应用依赖项。
本页面适用于 OpenClaw 进程外部的代码。在 OpenClaw 内部运行的插件代码应改用已文档化的 openclaw/plugin-sdk/* 子路径。

​
目前可用内容

接口面状态用途
Gateway 网关协议就绪WebSocket 传输、连接握手、认证权限范围、协议版本控制和事件。
Gateway RPC 参考就绪当前用于智能体、会话、任务、模型、工具、工件和审批的 Gateway 网关方法。
openclaw agent就绪当通过 shell 调用 CLI 已足够时，用于一次性脚本集成。
openclaw message就绪从脚本发送消息或渠道操作。
未来的客户端库包正在内部开发中，但它还不是公开的安装接口面。在发布版本化的公开包之前，请将其视为预览版实现细节。

​
推荐路径

  1. 运行或发现一个 Gateway 网关。
  2. 通过 Gateway 网关协议连接。
  3. 调用 Gateway RPC 参考中已文档化的 RPC 方法。
  4. 固定你测试所针对的 OpenClaw 版本。
  5. 升级 OpenClaw 时重新检查 RPC 参考。
对于智能体运行，从 agent RPC 开始，并将其与 agent.wait 配对以获取终态结果。对于持久的对话状态，请使用 sessions.* 方法。对于 UI 集成，请订阅 Gateway 网关事件，并且只渲染你的应用能够理解的事件族。

​
应用代码与插件代码

当代码位于 OpenClaw 外部时，请使用 Gateway 网关 RPC：
  • 启动或观察智能体运行的 Node 脚本
  • 调用 Gateway 网关的 CI 任务
  • 仪表板和管理面板
  • IDE 扩展
  • 不需要成为渠道插件的外部桥接
  • 使用模拟或真实 Gateway 网关传输的集成测试
当代码在 OpenClaw 内部运行时，请使用插件 SDK：
  • 提供商插件
  • 渠道插件
  • 工具或生命周期钩子
  • 智能体 harness 插件
  • 可信运行时辅助工具
外部应用不应导入 openclaw/plugin-sdk/*；这些子路径供 OpenClaw 加载的插件使用。

​
相关内容