基础 URL
版本控制
所有资源端点以/v1 为前缀。OAuth 和发现端点不带版本号。
身份验证
大多数端点需要 Bearer 令牌。在Authorization 请求头中传递:
响应格式
所有响应返回 JSON。成功的响应使用标准 HTTP 状态码:错误响应
验证错误返回422 状态码,并附带哪些字段验证失败的详细信息:
run 使用了哪种计算资源
有两个字段描述 run 的计算资源,它们回答的是不同的问题:
托管 run 中两者一致:你得到的就是你申请的档位,因此
compute_type 就是该档位
(如 gpu-h100)。在 BYO 集群上两者并不一致。此时 compute_type 给出集群自己
上报的 GPU 型号 —— 来自 sinfo 的 GRES 类型,例如 nvidia_gb200 —— 若集群未
上报则为 unknown。因此它是自由字符串,而不是固定的取值集合。
启动 run 时发送的 compute_type 含义不同:那是你所申请的内容,在 BYO 集群上
它承载一个用于推导 GPU 申请的兼容档位。申请与记录是两个不同的值,在 BYO 上并不
相同。
下载 URL
返回文件内容的端点——运行日志(stdout_url / stderr_url)和运行产物
(download_url)——返回的是短期有效的预签名 URL,而不是字节本身。每个 URL
自签发起最多有效 1 小时,而日志 URL 通过缓存提供,因此剩余时间可能更短。
请不要保存这些 URL。保存下来的 URL 之后只会返回 Request has expired。
请改为保存 run_id(以及产物路径),在真正需要文件时重新获取 URL:
端点分组
使用侧边栏浏览所有可用端点,按分组组织:- 仓库 — 注册、列出和管理仓库
- 仓库文件 — 浏览仓库中的文件
- 代码分析 — 启动、监控和管理代码分析
- 代码执行 — 运行代码并获取执行结果
- 运行流式传输 — 通过 SSE 实时流式传输 stdout/stderr 日志
- API 密钥 — 创建和撤销 API 密钥
- 环境变量 — 管理执行环境变量
- GitHub 集成 — 连接和管理 GitHub 仓库
- GitHub App Webhooks — 接收 push 和 pull request 事件以进行自动分析
- OAuth 2.0 — 授权、令牌和客户端注册

