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

# Cargo

> Connect Cargo to your Atako agents — 11 read and 2 write actions.

Let your agents list data models, read and create records, manage segments, list plays and workflows, trigger workflow runs, and list workspace connectors via the Cargo API.

## Connection

* **Authentication**: API key (API token).

<Note>
  Install the Cargo CLI: npm install -g @cargo-ai/cli. Then run: cargo-ai login --email [you@company.com](mailto:you@company.com). A new account starts with 100 free credits and needs no card. The --email flag mails a one-time code and creates the account and a workspace on first use. In an agent or sandbox shell with no terminal to prompt at, the first --email call sends the code and exits; re-run it with --code. Once logged in, the CLI stores a token at \~/.cargo/credentials. Copy the token value. Alternatively: cargo-ai login --oauth (opens a browser), or set the CARGO\_API\_TOKEN environment variable with an existing token. The token grants full access to the workspace — no additional scopes need to be configured.

  See [Cargo's documentation](https://www.getcargo.ai/developers/auth).
</Note>

## Read actions (11)

| Action            | Description                                          |
| ----------------- | ---------------------------------------------------- |
| `get_model`       | Retrieve a data model by UUID.                       |
| `get_play`        | Retrieve a play by UUID.                             |
| `get_run`         | Retrieve the status of an orchestration run by UUID. |
| `get_segment`     | Retrieve a segment by UUID.                          |
| `get_workflow`    | Retrieve a workflow by UUID.                         |
| `list_connectors` | List all connectors configured in the workspace.     |
| `list_models`     | List all data models in the workspace.               |
| `list_plays`      | List all plays.                                      |
| `list_records`    | List records for a data model.                       |
| `list_segments`   | List all segments.                                   |
| `list_workflows`  | List all workflows.                                  |

## Write actions (2)

| Action          | Description                                                                                       |
| --------------- | ------------------------------------------------------------------------------------------------- |
| `create_record` | Insert a single record into a data model.                                                         |
| `trigger_run`   | Trigger a workflow execution. Returns 202 Accepted with a Location header to poll for completion. |

## Permissions

Every action above must be explicitly granted to an agent before it can be used. See [Permissions](/integrations/permissions) for the grant model and [Security](/integrations/security) for how credentials are protected.