Skip to content

API 总览

Cube Sandbox 当前面向用户会出现两类 API:

  • 管理 API:主要服务于 Web Dashboard、运维巡检和内部控制面集成
  • E2B 兼容 API:主要服务于应用开发者、Agent 运行时和 SDK 接入

这两类 API 的目标读者、鉴权方式和使用心智并不完全一样。为了避免混淆,建议先明确自己属于哪种场景,再选择继续阅读路径。

什么时候看管理 API

如果你更关注下面这些问题,应优先看管理 API:

  • 如何查看集群概览、节点状态和模板详情
  • 如何查询沙箱详情、暂停、恢复、终止或查看结构化日志
  • 如何为内部平台或运维脚本接入 Dashboard 同源管理接口
  • 如何理解 Web Dashboard 背后的接口边界

管理 API 当前以 /cubeapi/v1 为基础路径,文档事实来源以 CubeSandbox/openapi.yml 为准。

什么时候看 E2B 兼容 API

如果你更关注下面这些问题,应优先看 E2B 兼容 API:

  • 如何继续使用 E2B SDK,但把请求指向 Cube Sandbox
  • 如何设置 E2B_API_URLE2B_API_KEY 和模板相关环境变量
  • 如何从应用代码直接创建沙箱并执行代码
  • 如何在开发机或 sidecar 场景中接入已有集群

E2B 兼容 API 更偏应用开发者心智,不等于 Dashboard 的管理面接口。

两类 API 的核心区别

维度管理 APIE2B 兼容 API
主要面向谁运维、平台、Dashboard 集成应用开发者、Agent、SDK 使用者
主要用途巡检、控制、查询、生命周期管理业务代码创建和使用沙箱
常见入口/cubeapi/v1/*E2B_API_URL 指向的兼容入口
常见鉴权头X-API-KeyAuthorization: BearerAuthorization: Bearer
推荐阅读管理 API 文档接入与快速开始文档

鉴权方式对照

Cube Sandbox 支持两类常见凭证格式:

  • Authorization: Bearer <token>
  • X-API-Key: <key>

其中:

  • E2B SDK 默认走 Authorization: Bearer
  • Web Dashboard 通常会在浏览器本地保存 API Key,并自动附加 X-API-Key

两者同时存在时,Authorization: Bearer 优先。

更完整的说明请继续阅读:

推荐阅读路径

如果你是运维或平台同学

  1. 先看 API 鉴权说明
  2. 再看 管理 API 总览
  3. 如果你主要关心节点和容量,再看 管理 API:节点
  4. 如果你主要关心模板,再看 管理 API:模板
  5. 如果你主要关心探活,再看 管理 API:健康检查
  6. 如果你主要关心实例与日志,再看 管理 API:沙箱与日志
  7. 如果你要先按状态码判断问题,再看 管理 API 错误码与排障矩阵

如果你是应用开发者

  1. 先看 E2B 兼容接入
  2. 再看 E2B 兼容 API 参考
  3. 再看 E2B 兼容 API:沙箱与执行
  4. 再回看 快速开始
  5. 或继续看 连接到已有 Cube 集群

与 Dashboard 文档的关系

Dashboard 文档更偏“在 UI 里怎么看、怎么点、下一步去哪一页”;API 文档更偏“这个能力在接口层如何组织、适合什么调用方、有哪些边界”。

如果你已经在使用 Web Dashboard,建议同时参考: