Documentação para desenvolvedoresAPI reference
Overview
Base URL, conventions and every endpoint.
https://runner.cargoduo.com/v1JSON over HTTPS. Lengths in cm, weights in kg, money in credits.
Endpoints
Pack
| Endpoint | Page | Scope |
|---|---|---|
POST /v1/pack | Create a packing job | pack:write |
POST /v1/estimate | Estimate a packing job | pack:write |
Jobs
| Endpoint | Page | Scope |
|---|---|---|
GET /v1/jobs | List jobs | jobs:read |
GET /v1/jobs/{id} | Get a job | jobs:read |
GET /v1/jobs/{id}/result | Get a job result | jobs:read |
DELETE /v1/jobs/{id} | Cancel a job | pack:write |
Projects
| Endpoint | Page | Scope |
|---|---|---|
GET /v1/projects | List projects | resources:read |
POST /v1/projects | Create a project | resources:write |
GET /v1/projects/{id} | Get a project | resources:read |
PATCH /v1/projects/{id} | Update a project | resources:write |
DELETE /v1/projects/{id} | Delete a project | resources:write |
POST /v1/projects/{id}/pack | Pack a project | pack:write and resources:write |
Vehicles
| Endpoint | Page | Scope |
|---|---|---|
GET /v1/vehicles | List vehicles | resources:read |
GET /v1/vehicles/{id} | Get a vehicle | resources:read |
POST /v1/vehicles | Create a vehicle | resources:write |
PATCH /v1/vehicles/{id} | Update a vehicle | resources:write |
DELETE /v1/vehicles/{id} | Delete a vehicle | resources:write |
Templates
| Endpoint | Page | Scope |
|---|---|---|
GET /v1/templates | List templates | resources:read |
GET /v1/templates/{id} | Get a template | resources:read |
POST /v1/templates | Create a template | resources:write |
PATCH /v1/templates/{id} | Update a template | resources:write |
DELETE /v1/templates/{id} | Delete a template | resources:write |
Account
| Endpoint | Page | Scope |
|---|---|---|
GET /v1/limits | Get limits | account:read |
GET /v1/balance | Get the balance | account:read |
GET /v1/usage | Get usage | account:read |
Headers
| Header | Direction | Meaning |
|---|---|---|
Authorization | Request | Bearer cd_live_… |
Content-Type | Request | application/json on POST |
Idempotency-Key | Request | Safe retries of POST /v1/pack and POST /v1/projects/{id}/pack |
X-Request-Id | Response | Request id (req_…), on every response |
X-RateLimit-Limit / -Remaining / -Reset | Response | The tightest rate window |
X-Credits-Remaining | Response | Available credits after the request |
Retry-After | Response | Seconds to wait, on 429 |
Idempotent-Replayed | Response | true when a key replayed an earlier job |
Machine-readable
openapi.jsonOpenAPI 3.1, every endpoint and schema.llms-full.txtthe integration playbook for coding agents.