Skip to main content
The OpenAPI specification is the machine-readable description of the Cargo REST API. Fetch this file rather than scraping HTML. /openapi and /spec on getcargo.ai rewrite to /openapi.json. The spec describes:
  • The REST server at https://api.getcargo.io/v1
  • Bearer and OAuth 2.0 security schemes, including named scopes
  • Typed request and response schemas
  • Idempotency-Key on write operations
  • A shared error schema on 4xx and 5xx responses
  • Deprecation and Sunset headers on retired operations
See API Reference for the prose companion and Authentication for how to get a token.