Gateway RPC

WebSocket RPC 接口文档

Crab Claw Gateway 通过 WebSocket 提供 JSON-RPC 2.0 接口，所有 CLI 命令和前端操作都通过此接口通信。

连接

shell

ws://localhost:19001/ws
ws://localhost:19001/ws

启用 TLS 时：

shell

wss://localhost:19001/ws
wss://localhost:19001/ws

消息格式

请求

json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.send",
  "params": {
    "message": "你好"
  }
}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "chat.send",
  "params": {
    "message": "你好"
  }
}

响应

json

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "status": "ok",
    "data": { ... }
  }
}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "status": "ok",
    "data": { ... }
  }
}

主要方法分类

chat.* — 对话

方法	说明
`chat.send`	发送消息
`chat.active_runs`	查看活跃的对话

agent.* — 智能体

方法	说明
`agent.add`	创建智能体
`agent.list`	列出智能体
`agent.remove`	删除智能体

models.* — 模型

方法	说明
`models.list`	列出可用模型
`models.set`	设置默认模型
`models.auth.state`	查看认证状态

channels.* — 频道

方法	说明
`channels.list`	列出频道状态
`channels.approve`	确认配对

skills.* — 技能

方法	说明
`skills.list`	列出技能
`skills.codegen`	编译组合技能
`skills.codegen.status`	查看编译状态
`skills.run`	查询组合工具元信息

sessions.* — 会话

方法	说明
`sessions.list`	列出活跃会话
`sessions.history`	会话历史
`sessions.send`	向会话发消息
`sessions.spawn`	创建子会话

config.* — 配置

方法	说明
`config.get`	读取配置
`config.update`	更新配置

browser.* — 浏览器

方法	说明
`browser.request`	浏览器操作请求

media.* — 媒体

方法	说明
`media.config.get`	媒体配置
`media.patrol.status`	巡逻状态
`media.patrol.events`	巡逻事件
`media.patrol.summary`	巡逻摘要

认证

RPC 连接支持 Token 认证：

json

{
  "method": "auth.login",
  "params": {
    "token": "your-gateway-token"
  }
}
{
  "method": "auth.login",
  "params": {
    "token": "your-gateway-token"
  }
}

错误码

码	说明
-32600	无效请求
-32601	方法不存在
-32602	参数错误
-32603	内部错误
401	认证失败
403	权限不足