Documentation développeursRéférence de l'API
Vue d'ensemble
URL de base, conventions et liste complète des endpoints.
https://runner.cargoduo.com/v1JSON sur HTTPS. Longueurs en cm, poids en kg, montants en crédits.
Endpoints
Chargement
| Endpoint | Page | Autorisation |
|---|---|---|
POST /v1/pack | Créer une tâche de chargement | pack:write |
POST /v1/estimate | Estimer une tâche de chargement | pack:write |
Tâches
| Endpoint | Page | Autorisation |
|---|---|---|
GET /v1/jobs | Lister les tâches | jobs:read |
GET /v1/jobs/{id} | Consulter une tâche | jobs:read |
GET /v1/jobs/{id}/result | Consulter le résultat d'une tâche | jobs:read |
DELETE /v1/jobs/{id} | Annuler une tâche | pack:write |
Projets
| Endpoint | Page | Autorisation |
|---|---|---|
GET /v1/projects | Lister les projets | resources:read |
POST /v1/projects | Créer un projet | resources:write |
GET /v1/projects/{id} | Consulter un projet | resources:read |
PATCH /v1/projects/{id} | Mettre à jour un projet | resources:write |
DELETE /v1/projects/{id} | Supprimer un projet | resources:write |
POST /v1/projects/{id}/pack | Calculer le chargement d'un projet | pack:write et resources:write |
Véhicules
| Endpoint | Page | Autorisation |
|---|---|---|
GET /v1/vehicles | Lister les véhicules | resources:read |
GET /v1/vehicles/{id} | Consulter un véhicule | resources:read |
POST /v1/vehicles | Créer un véhicule | resources:write |
PATCH /v1/vehicles/{id} | Mettre à jour un véhicule | resources:write |
DELETE /v1/vehicles/{id} | Supprimer un véhicule | resources:write |
Modèles
| Endpoint | Page | Autorisation |
|---|---|---|
GET /v1/templates | Lister les modèles | resources:read |
GET /v1/templates/{id} | Consulter un modèle | resources:read |
POST /v1/templates | Créer un modèle | resources:write |
PATCH /v1/templates/{id} | Mettre à jour un modèle | resources:write |
DELETE /v1/templates/{id} | Supprimer un modèle | resources:write |
Compte
| Endpoint | Page | Autorisation |
|---|---|---|
GET /v1/limits | Consulter les limites | account:read |
GET /v1/balance | Consulter le solde | account:read |
GET /v1/usage | Consulter l'utilisation | account:read |
En-têtes
| En-tête | Sens | Signification |
|---|---|---|
Authorization | Requête | Bearer cd_live_… |
Content-Type | Requête | application/json en POST |
Idempotency-Key | Requête | Nouvelles tentatives sûres de POST /v1/pack et POST /v1/projects/{id}/pack |
X-Request-Id | Réponse | ID de la requête (req_…), dans chaque réponse |
X-RateLimit-Limit / -Remaining / -Reset | Réponse | La fenêtre de débit la plus restrictive |
X-Credits-Remaining | Réponse | Crédits disponibles après la requête |
Retry-After | Réponse | Nombre de secondes à attendre, en cas de 429 |
Idempotent-Replayed | Réponse | true quand une clé a renvoyé une tâche antérieure |
Formats lisibles par machine
- openapi.json : OpenAPI 3.1, tous les endpoints et schémas.
- llms-full.txt : le guide d'intégration pour les agents de codage.