Skip to main content
The Cargo API allows you to programmatically interact with the Cargo platform. Use it to manage your data models, orchestrate workflows, build AI agents, and integrate with your existing systems. For JavaScript and TypeScript, you can use our official client library @cargo-ai/api for a typed, convenient way to call the API.

​
Platform Overview

Cargo is built around eight core domains that work together to automate your go-to-market operations:

​
Core Entities

​
Base URL

All API requests should be made to:

​
Authentication

The Cargo API uses Bearer token authentication. Include your API token in the Authorization header of all requests:

​
Getting your API Token

  1. Navigate to your workspace settings
  2. Go to Settings > API Tokens
  3. Click Create Token and copy the generated token
Keep your API token secure. Never share it publicly or commit it to version control.

​
Response Format

All API responses are returned in JSON format. Data is returned directly at the root level.

​
Success Response

​
Error Response

Or for specific error types:

​
Rate Limiting

API requests are counted per workspace. Every /v1 response — including 401 Unauthorized — carries the current limit so a client can throttle before it is rejected. If you exceed the limit, the API returns 429 Too Many Requests. Back off by Retry-After; do not retry immediately.

​
Versioning and deprecation

The API is versioned in the URL path (/v1). See Versioning and deprecation for the policy: what counts as breaking, how Deprecation (RFC 9745) and Sunset (RFC 8594) headers work, and the 180-day minimum between them.