Cargo OpenAPI spec

The Cargo OpenAPI spec is the machine-readable description of the Cargo REST API: OpenAPI 3.1.0, 280 paths, 340 operations. Agents and SDK generators should fetch this file rather than scrape the HTML docs.

Where to get it

/openapi and /spec on this host rewrite to /openapi.json, so a client that guesses those names still receives the document.

What it 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 on essentially every operation
• Idempotency-Key on write operations
• A shared error schema on 4xx and 5xx responses
• Deprecation and Sunset headers on retired operations

How to use it

curl -s https://www.getcargo.ai/openapi.json | head

Point an OpenAPI-aware client, an SDK generator, or an agent at that URL. The Cargo API docs are the prose companion. Authentication is in the Cargo auth docs.