API Reference

Base URL: https://api.cnvy.ai

Interactive API documentation (Swagger UI) is available at: https://api.cnvy.ai/docs

Authentication

Convoy uses API key authentication. Include your key in the request header:


curl -H "X-API-Key: convoy_sk_your_key_here" https://api.cnvy.ai/cargo/...

See Authentication for details on obtaining API keys from the dashboard.

These endpoints require the X-API-Key header with a valid project API key.

Method	Endpoint	Description
`POST`	`/cargo/load`	Submit a request for batch processing
`GET`	`/cargo/{cargo_id}/tracking`	Get status of a request

No authentication required.

Method	Endpoint	Description
`GET`	`/health`	Health check

All responses are JSON. Successful responses return 2xx status codes.


{
  "cargo_id": "crg_abc123def456",
  "status": "success",
  "message": "Cargo loaded successfully"
}


{
  "detail": "Error message describing what went wrong"
}

Status	Description
`400`	Bad Request — Invalid request body or parameters
`401`	Unauthorized — Missing or invalid API key
`403`	Forbidden — Project is inactive
`404`	Not Found — Resource doesn’t exist or not owned by project
`500`	Internal Server Error — Something went wrong on our end

Rate limits vary by plan. Contact us for information about limits and higher-throughput options.