OpenClaw Studio API 参考:/api/runtime 与 /api/intents 路由完全清单
OpenClaw Studio API 参考/api/runtime 与 /api/intents 路由完全清单【免费下载链接】openclaw-studioA clean web dashboard for OpenClaw. Connect your Gateway, manage agents, and ship faster. ⭐️ Star if you like it!项目地址: https://gitcode.com/gh_mirrors/op/openclaw-studioOpenClaw Studio 是 OpenClaw 的官方 Web 控制台连接 Gateway、管理智能体Agent、聊天、审批与定时任务一站完成。本文是它 HTTP API 的完整清单指南——逐条讲清/api/runtime/*读数据与/api/intents/*写操作两类路由的职责、方法与使用场景帮你在 10 分钟内建立完整的接口心智模型。先搞懂两条 API 的分工OpenClaw Studio 采用「服务端控制平面」架构浏览器只与 Studio 说话Studio 再持有唯一一条到 Gateway 的 WebSocket。用一句话区分两类路由/api/runtime/*读为主。查 Agent 列表、聊天历史、模型列表、定时任务、状态摘要以及最重要的SSE 事件流。/api/intents/*写操作。创建/删除/重命名 Agent、发消息、审批执行、增删 Cron 任务等。 记忆口诀runtime 是「看」intents 是「做」。/api/runtime 路由清单12 个所有 runtime 路由均为 Node.js 运行时Gateway 不可用时多数会降级返回503并附带degraded快照而不是直接报错。路由方法作用源码位置/api/runtime/fleetPOST从 Gateway 拉取 Agent 舰队列表配置快照支持降级恢复fleet/route.ts/api/runtime/streamGETSSE 事件流按lastEventId回放最多 2000 条 实时推送15 秒心跳保活stream/route.ts/api/runtime/agents/[agentId]/historyGET会话历史支持viewraw/semantic、limit、turnLimit≤400、includeThinking/Tools参数内置 20 秒缓存history/route.ts/api/runtime/agents/[agentId]/previewGETAgent 工作区文件预览preview/route.ts/api/runtime/agent-fileGET按agentIdname读取单个 Agent 文件如AGENTS.md、SOUL.mdagent-file/route.ts/api/runtime/agent-statePOST / PUTPOST 把 Agent 状态移入回收站PUT 从trashDir恢复agent-state/route.ts/api/runtime/configGET透传 Gatewayconfig.get读取当前配置config/route.ts/api/runtime/cronGET列出定时任务includeDisabled参数控制是否含已禁用项cron/route.ts/api/runtime/modelsGET可用模型列表模型策略快照models/route.ts/api/runtime/summaryGET控制平面快照outboxHead 等 数据新鲜度freshnesssummary/route.ts/api/runtime/mediaGET会话媒体图片等文件访问media/route.ts/api/runtime/disconnectPOST断开 Studio 到 Gateway 的 WebSocketdisconnect/route.ts重点拆解SSE 流/api/runtime/stream这是界面「实时感」的来源。要点通过查询参数lastEventId或Last-Event-ID请求头告诉服务端「我收到哪了」服务端从断点回放未带断点时默认回放最近 2000 条事件保证刷新页面不丢消息事件分两类gateway.eventGateway 侧原始事件与runtime.status本地运行时状态每 15 秒发送: heartbeat注释帧防止代理/防火墙掐断长连接。聊天流式渲染的完整机制可参考 docs/pi-chat-streaming.md。/api/intents 路由清单15 个intents 路由全部为POST JSON 请求体对应一次明确的业务意图。Agent 生命周期6 个路由作用源码位置/api/intents/agent-create创建 Agent含人格、工具策略、沙箱配置agent-create/route.ts/api/intents/agent-delete删除 Agent状态先入回收站agent-delete/route.ts/api/intents/agent-rename重命名 Agentagent-rename/route.ts/api/intents/agent-file-set写入 Agent 文件agent-file-set/route.ts/api/intents/agent-permissions-update更新工具策略/沙箱/审批等权限设置agent-permissions-update/route.ts/api/intents/agent-wait轮询等待 Agent 创建就绪agent-wait/route.ts聊天与会话3 个路由作用源码位置/api/intents/chat-send发送聊天消息流式回复走 SSE 流chat-send/route.ts/api/intents/chat-abort中止当前生成chat-abort/route.ts/api/intents/sessions-reset重置会话sessions-reset/route.ts/api/intents/session-settings-sync同步会话级设置到 Gatewaysession-settings-sync/route.ts定时任务5 个路由作用源码位置/api/intents/cron-add新增定时任务cron-add/route.ts/api/intents/cron-run手动立即执行一次cron-run/route.ts/api/intents/cron-remove删除指定任务cron-remove/route.ts/api/intents/cron-remove-agent删除某 Agent 关联的全部任务cron-remove-agent/route.ts/api/intents/cron-restore恢复已删除的任务cron-restore/route.ts执行审批1 个路由作用源码位置/api/intents/exec-approval-resolve批准/拒绝 Agent 的命令执行请求exec-approval-resolve/route.ts审批的权限与沙箱联动机制详见 docs/permissions-sandboxing.md。附带路由Studio 自身配置2 个路由方法作用源码位置/api/studioGET / PUT读取/保存 Studio 的 Gateway URL 与 Token 等设置route.ts/api/studio/test-connectionPOST测试与 Gateway 的连接是否可用test-connection/route.ts通用行为与排错速查503 reason: gateway_unavailableGateway 没连上。此时fleet等路由会返回degraded: true用本地事件回放尽力恢复界面。404 domain_api_mode_disabled该路由在当前模式不可用正常不会出现域名 API 模式始终开启。INSUFFICIENT_SCOPEGateway token 权限不足界面会提示降级展示。所有状态码/错误语义由控制平面统一封装前端按code字段做分支处理。 常见排查与错误码对照如EPROTO、401 访问令牌、better_sqlite3版本不匹配见 README.md 的 Troubleshooting 章节整体模块与数据流见 ARCHITECTURE.md。小结OpenClaw Studio 的 API 设计非常克制12 个 runtime 读路由 15 个 intents 写路由职责单一、命名直观。理解「runtime 看、intents 做、SSE 管实时」这三条主线你就能看懂控制平面几乎所有源码也为二次开发或自建集成打下完整基础。【免费下载链接】openclaw-studioA clean web dashboard for OpenClaw. Connect your Gateway, manage agents, and ship faster. ⭐️ Star if you like it!项目地址: https://gitcode.com/gh_mirrors/op/openclaw-studio创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考