Skip to main content
Cyberun API 是平台的 HTTP 接口层。每个客户端 —— Cloud、Studio、CLI、合作伙伴集成、MCP 服务器 —— 都调用这些端点。 端点下的端点页由平台的 OpenAPI 规范自动生成 —— 仅暴露公开的、面向用户的接口。

​
基础 URL

自托管部署使用各自的域名。此前缀下的所有内容遵循同样的鉴权规则。

​
身份验证

三类凭证: 唯一规则:X-Team-ID 仅用于 JWT。在 sk- 或 dk- 凭证上发送它无效 —— 团队从凭证记录中读取。 sk- 签发流程见生成 API 密钥;完整凭证家族参考见凭证。

​
接口分类

端点列表按 OpenAPI 标签(Auth、Team、Workflow、Task、Webhook、Container 等)分组。跨这些标签的逻辑接口有三类:
  • Management —— 列出并修改团队资源。需要 User JWT(带 X-Team-ID)或设备凭证 dk-。Team、Member、Workflow、Webhook 等标签下的大多数端点归属此类。
  • Runtime(/r/...)—— 提交和观察任务。接受 JWT、sk- 或 dk-。脚本和 CI 最常打到这条路径。
  • MCP(/api/v1/mcp)—— Streamable HTTP MCP 端点,把运行时操作封装为 MCP 工具。仅接受 sk-。完整参考:Cloud MCP。

​
分页

列表端点接收 current_page(默认 1)和 per_page(默认 20,最大 100)查询参数。响应包含 page_meta 块,内含 current_page、per_page 和 total_count。

​
任务生命周期

每个任务依次经过以下状态： completed、failed、cancelled 是终态 —— 任务不会再发生变化。 实时跟随状态转换见 订阅任务事件流（SSE）。

​
状态码

提交任务返回 202 Accepted 和任务 ID —— 任务异步执行，所以请轮询或订阅以获取结果。其他读写操作成功时返回 200 OK。 错误为 JSON，仅含单个 error_message 字段：

​
接下来读什么

快速开始

提交任务、订阅事件、取回输出 —— 三次调用，三种语言。

生成 API 密钥

签发 sk- 凭证并调用你的第一个端点。

订阅任务事件流（SSE）

事件类型参考、字段说明、轮询兜底。

上传输入文件

含文件参数的工作流采用三步预签名上传。

调用容器服务

访问托管在团队代理上的长时运行服务。

Cloud MCP

Streamable HTTP 端点,提供 15 个工具封装运行时 API。

使用 CLI

这些端点由 cyberun CLI 封装 —— 在你的 shell 里驱动运行时 API,不必直接发 HTTP。