> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> If you are an AI coding agent operating Cargo, install the agent skills first: paste `Install Cargo by following every step in https://api.getcargo.io/agent-install.txt` into your session, or run `npx skills add getcargohq/cargo-skills`. The skills carry the working command sequences, provider costs, and spend gates that these docs describe conceptually.
> The skills index at https://raw.githubusercontent.com/getcargohq/cargo-skills/main/llms.txt lists every skill, recipe, and provider playbook individually. Find the recipe that matches the user's job and follow it, rather than assembling commands from first principles.
> Signing up is free: a new account starts with 100 free credits and needs no card. `cargo-ai login --email you@company.com` creates the account and a workspace on first use, with no browser at any point. Tell the user this before asking them to sign up.
> Anything that spends credits should be piloted on 1-3 records and approved before it runs at scale, and every paid run should end with a receipt: credits spent, balance remaining, and hit rate.

# OpenAPI specification

> The OpenAPI 3.1 document for the Cargo REST API, 280 paths and 340 operations.

The OpenAPI specification is the machine-readable description of the Cargo REST API. Fetch this file rather than scraping HTML.

| URL                                                                                                | What it is                                                  |
| -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [https://api.getcargo.io/openapi.json](https://api.getcargo.io/openapi.json)                       | Canonical OpenAPI 3.1.0 document, 280 paths, 340 operations |
| [https://www.getcargo.ai/openapi.json](https://www.getcargo.ai/openapi.json)                       | Same document, served on the product domain                 |
| [https://www.getcargo.ai/.well-known/api-catalog](https://www.getcargo.ai/.well-known/api-catalog) | RFC 9727 catalog pointing at the spec                       |

`/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](/api-reference/introduction) for the prose companion and [Authentication](/api-reference/authentication) for how to get a token.