Skip to main content
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).
Install the Cargo CLI: npm install -g @cargo-ai/cli. Then run: cargo-ai login —email 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.

​
Read actions (11)

​
Write actions (2)

​
Permissions

Every action above must be explicitly granted to an agent before it can be used. See Permissions for the grant model and Security for how credentials are protected.