Skip to content

模板 API ​

请求发送到 DEVBOX_API_URL,使用 X-API-Key。模板列表用于选择初始软件环境、资源规格与 Build。

列出模板 ​

GET /templates

也支持 GET /v2/templates。可选分页参数:

Query 参数类型说明
limitinteger每页 1–1000 条;省略或 0 返回全部匹配项
nextTokenstring上一页 X-Next-Token 响应头,按原值传回

响应头 X-Next-Token 为空表示没有下一页。

bash
curl --fail-with-body "$DEVBOX_API_URL/templates" \
  -H "X-API-Key: $DEVBOX_API_KEY"

成功返回 HTTP 200,JSON 为数组,空列表为 []:

json
[
  {
    "templateID": "<template-id>",
    "name": "devbox-base",
    "aliases": ["default"],
    "buildID": "<build-id>",
    "cpuCount": 2,
    "memoryMB": 1024,
    "diskSizeMB": 2040
  }
]
字段类型说明
templateIDstring创建时传入的模板 ID
namestring展示名称
namesstring[]E2B 兼容的模板名称数组,包含可用于创建的别名
aliasesstring[]可用于创建的别名
buildIDstring该模板当前最新可用 Build
cpuCountintegerCPU 核数
memoryMBinteger内存规格,单位 MiB
diskSizeMBinteger磁盘规格,单位 MiB
publicboolean当前列表中的模板均为公开模板
createdAt / updatedAtstring模板创建、更新时间
lastSpawnedAtstring / null最近创建沙箱时间
spawnCount / buildCountinteger创建沙箱次数、Build 数量
createdByobject / null创建人资料,当前为 null
envdVersionstringEnvD 协议版本
buildStatusstring返回的可用 Build 为 ready

列表展示当前可用的公共模板,每个模板包含一个可供创建的 Build。将返回的 templateID 或别名传入创建沙箱;需要固定环境时,同时传入 buildID。

鉴权错误返回 401,API Key 的 scope 不是 devbox 时返回 403。公共错误约定见通用约定。