开发者文档API 参考
概览
基础 URL、通用约定和全部接口。
https://runner.cargoduo.com/v1基于 HTTPS 的 JSON。长度以 cm 为单位，重量以 kg 为单位，金额以积分计。
接口
装载
任务
| 接口 | 页面 | 权限范围 |
|---|---|---|
GET /v1/jobs | 列出任务 | jobs:read |
GET /v1/jobs/{id} | 查询任务 | jobs:read |
GET /v1/jobs/{id}/result | 查询任务结果 | jobs:read |
DELETE /v1/jobs/{id} | 取消任务 | pack:write |
项目
| 接口 | 页面 | 权限范围 |
|---|---|---|
GET /v1/projects | 列出项目 | resources:read |
POST /v1/projects | 创建项目 | resources:write |
GET /v1/projects/{id} | 查询项目 | resources:read |
PATCH /v1/projects/{id} | 更新项目 | resources:write |
DELETE /v1/projects/{id} | 删除项目 | resources:write |
POST /v1/projects/{id}/pack | 计算项目装载方案 | pack:write 和 resources:write |
车辆
| 接口 | 页面 | 权限范围 |
|---|---|---|
GET /v1/vehicles | 列出车辆 | resources:read |
GET /v1/vehicles/{id} | 查询车辆 | resources:read |
POST /v1/vehicles | 创建车辆 | resources:write |
PATCH /v1/vehicles/{id} | 更新车辆 | resources:write |
DELETE /v1/vehicles/{id} | 删除车辆 | resources:write |
模板
| 接口 | 页面 | 权限范围 |
|---|---|---|
GET /v1/templates | 列出模板 | resources:read |
GET /v1/templates/{id} | 查询模板 | resources:read |
POST /v1/templates | 创建模板 | resources:write |
PATCH /v1/templates/{id} | 更新模板 | resources:write |
DELETE /v1/templates/{id} | 删除模板 | resources:write |
账户
HTTP 头
| HTTP 头 | 方向 | 含义 |
|---|---|---|
Authorization | 请求 | Bearer cd_live_… |
Content-Type | 请求 | POST 请求时为 application/json |
Idempotency-Key | 请求 | 安全重试 POST /v1/pack 和 POST /v1/projects/{id}/pack |
X-Request-Id | 响应 | 请求 ID（req_…），每个响应都会返回 |
X-RateLimit-Limit / -Remaining / -Reset | 响应 | 最严格的限流窗口 |
X-Credits-Remaining | 响应 | 本次请求后的可用积分 |
Retry-After | 响应 | 返回 429 时：需等待的秒数 |
Idempotent-Replayed | 响应 | 键重放了先前的任务时为 true |
机器可读
- openapi.json：OpenAPI 3.1，包含所有接口和 Schema。
- llms-full.txt：面向编程 Agent 的集成手册。