# Cargo Documentation > Build and operate a revenue engine on Cargo from your terminal: unified data models, tools, plays, AI agents, alerts, and a full workspace-as-code CDK, driven from Claude Code, Codex, or Cursor through 17 agent skills over the cargo-ai CLI. A new account starts with 100 free credits and no card. > ## 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://github.com/getcargohq/cargo-skills/blob/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. ## Docs - [Introduction](https://docs.getcargo.ai/index.md): Cargo is a framework for GTM. Define your entire workspace — connectors, models, tools, agents, and plays — as TypeScript files and deploy it with one command. - [Quickstart](https://docs.getcargo.ai/get-started/quickstart.md): Install the Cargo CLI, authenticate, scaffold a workspace, define a tool, and deploy it — end to end. - [Project layout](https://docs.getcargo.ai/get-started/project-layout.md): How a Cargo workspace is organized as files, how the loader turns them into resources, and how state keeps code and live infra in sync. - [CLI, CDK & Skills](https://docs.getcargo.ai/get-started/cli-cdk-and-skills.md): Three ways to operate Cargo through one binary and one login: imperative CLI commands for one-off work, declarative CDK for a whole workspace in git, and agent Skills so Claude Code, Codex, or Cursor can do it from a plain-English request. Signing up is free — 100 credits, no card. - [End-to-end recipe](https://docs.getcargo.ai/get-started/recipe.md): Wire a connector, model, tool, agent, and play together in one workspace, deploy it with cargo-ai cdk, and run it — the full loop end to end. - [Connectors](https://docs.getcargo.ai/connectors/overview.md): Link Cargo to your CRM, warehouse, enrichment providers, and AI models with defineConnector — the foundation every model, tool, and agent builds on. - [Overview](https://docs.getcargo.ai/models/overview.md): Structured, queryable tables that power your plays and workflows. Define them in code with defineModel, sourced from a connector or owned by Cargo. - [Extractors](https://docs.getcargo.ai/models/extractors.md): How a connector action becomes a model's data source — the extractSlug and config that populate an integration-backed model. - [Object models](https://docs.getcargo.ai/models/object-models.md): Native, writable data models for the core entities of your GTM motion - [Unification](https://docs.getcargo.ai/models/unification.md): How Cargo merges records from multiple integrations into unified account, contact, and event models - [Relationships](https://docs.getcargo.ai/models/relationships.md): Join two models on shared columns — define them in code with defineRelationship so plays, metrics, and queries can traverse between related records. - [Querying Cargo data](https://docs.getcargo.ai/models/querying.md): Access your Cargo data models directly via SQL - [Track workspace activities](https://docs.getcargo.ai/models/activities.md): Track and analyze activities data from Cargo tools and plays using SQL queries - [Using UI](https://docs.getcargo.ai/models/using-ui.md): Learn about data models and how they power Cargo plays - [Segments](https://docs.getcargo.ai/models/segments.md): Named, filtered views of a model — define them in code with defineSegment and target them from batches, exports, and change feeds. - [Workflows](https://docs.getcargo.ai/workflows/overview.md): defineWorkflow — the TypeScript DSL that backs tools and plays. Author logic in code that compiles to the same nodes as the visual editor. - [Overview](https://docs.getcargo.ai/tools/overview.md): Reusable, single-purpose automations backed by a workflow. Define them with defineTool and call them from plays, agents, MCP servers, or the API. - [Triggering a tool](https://docs.getcargo.ai/tools/triggering.md): Run a tool from the CLI, on a schedule declared in code, from plays/agents/MCP, over the API, or from the UI - [Monitoring a tool](https://docs.getcargo.ai/tools/monitoring.md): Inspect runs, pull metrics, re-queue failures, and set alerts from the CLI — or the UI - [Public form](https://docs.getcargo.ai/tools/public-form.md): Expose a tool as a public, embeddable form that runs the tool's workflow on submit - [Using UI](https://docs.getcargo.ai/tools/using-ui.md): Learn what tools are, and how to build your first one. - [Triggering from Salesforce](https://docs.getcargo.ai/tools/embed-in-crm.md): Create a custom button inside the native Salesforce app in order to trigger the tool directly from within the CRM. - [Overview](https://docs.getcargo.ai/agents/overview.md): LLM-powered workers that reason, research, and act. Define them with defineAgent — wiring in tools, data models, sub-agents, and connector actions through one `uses` array. - [Prompt](https://docs.getcargo.ai/agents/prompt.md): The systemPrompt is the foundation of an agent's behavior — its mission, approach, and constraints, versioned in code. - [Native LLM Capabilities](https://docs.getcargo.ai/agents/native-llm-capabilities.md): Built-in features that enhance your Agent's reasoning, memory, and ability to interact with users and data. - [Tools & actions](https://docs.getcargo.ai/agents/tools-and-actions.md): Give an agent callable operations — your tools, connector actions, sub-agents, and MCP servers — on defineAgent. - [Resources & context](https://docs.getcargo.ai/agents/resources-and-context.md): Ground an agent in your data — models wired through defineAgent, files searched by vector similarity, and the context repository. - [Advanced settings](https://docs.getcargo.ai/agents/advanced.md): LLM selection, behavioral tuning, structured output, evaluators, triggers, and heartbeats — everything else on defineAgent. - [Using UI](https://docs.getcargo.ai/agents/using-ui.md): Learn what agents are, and how to build your first one. - [Overview](https://docs.getcargo.ai/plays/overview.md): Event-driven automations that run a workflow over a data model as its rows change. Define them with definePlay. - [Triggering a play](https://docs.getcargo.ai/plays/triggering.md): Declare a play's schedule, change detection, enrolment rules, and filters in code with definePlay - [Using UI](https://docs.getcargo.ai/plays/using-ui.md): Learn what plays are, how they differ from tools, and how to build your first one. - [Overview](https://docs.getcargo.ai/alerts/overview.md): Scheduled threshold checks over your telemetry, your warehouse SQL, or a model's records, firing actions when a metric breaches. Define them with defineAlert. - [Events](https://docs.getcargo.ai/alerts/events.md): Every alert evaluation records one event — the value it computed, the verdict, and the runs it fired. - [Using UI](https://docs.getcargo.ai/alerts/using-ui.md): Build an alert visually: pick what it watches with a live preview, set the threshold, and read its firing history. - [MCP servers](https://docs.getcargo.ai/mcp-servers/overview.md): Expose a curated set of your tools, agents, and data models to Claude Desktop, ChatGPT, Cursor, or any MCP client — remotely over HTTP with OAuth, or locally over stdio with cargo-ai mcp. - [Context](https://docs.getcargo.ai/context/overview.md): Sync your GTM knowledge base — markdown/MDX files — into the workspace context repository with defineContext. - [Files](https://docs.getcargo.ai/files/overview.md): Upload unstructured content — documents, PDFs, playbooks — as searchable resources with defineFile. - [Folders](https://docs.getcargo.ai/folders/overview.md): Organize resources of a given kind into folders with defineFolder. - [Workers & apps](https://docs.getcargo.ai/workers-and-apps/overview.md): Deploy hosted edge workers and Vite single-page apps as part of your workspace with defineWorker and defineApp. - [Overview](https://docs.getcargo.ai/territories/overview.md): Model your sales team structure and automate lead distribution across territories and capacities - [Members](https://docs.getcargo.ai/territories/members.md): The sales reps that leads are distributed to — imported from your CRM and enriched with routing metadata like languages and specializations. - [Territories](https://docs.getcargo.ai/territories/territories.md): Group members into named pools and distribute leads across them with weighted round-robin — the building block Allocate nodes route leads to. - [Capacities](https://docs.getcargo.ai/territories/capacities.md): Cap how many records each member receives within a time window — with fixed limits, expiring windows, or limits derived from a data model. - [Using UI](https://docs.getcargo.ai/territories/using-ui.md): Build territories and capacities in the workspace and route leads to them with an Allocate node — no code required. - [Deploying](https://docs.getcargo.ai/deploy/deploying.md): The CDK reconcile lifecycle — plan, deploy, prune, refresh, import and destroy — plus the flags that control confirmation, pruning and locking. - [State & Drift](https://docs.getcargo.ai/deploy/state-and-drift.md): How cargo.state.json links your code to deployed Cargo resources, why you commit it, the lock file, and detecting changes made outside the CDK with cdk refresh. - [Monitoring](https://docs.getcargo.ai/deploy/monitoring.md): Inspect runs, batches, spans, and traces from the CLI — and set up alerts — to see how your tools, plays, and agents perform. - [Cargo CLI Overview](https://docs.getcargo.ai/cli/overview.md): The Cargo CLI gives you programmatic, terminal-level access to every part of the Cargo platform — models, connectors, workflows, agents, billing, and workspace administration. - [Manifest](https://docs.getcargo.ai/cli/manifest.md): Scaffold a GTM repo and grow it with copy-in modules - [Cargo Skills](https://docs.getcargo.ai/skills/overview.md): Run your GTM motion from Claude Code, Cursor, or Codex: build lead lists, find and verify emails, enrich companies and contacts, score leads, sync to your CRM, and watch buying signals like job changes and funding. 17 agent skills over the cargo-ai CLI, with provider costs and spend gates. - [Examples](https://docs.getcargo.ai/skills/examples.md): Worked examples for the most common Cargo tasks — run tools, trigger plays, query the warehouse, build workflows, deploy agents, and more. - [Secrets & environments](https://docs.getcargo.ai/reference/secrets-and-environments.md): How secret() and env() differ, the CARGO_* environment variables the CLI reads, and how to promote the same CDK code to a second workspace. - [Expression cheat sheet](https://docs.getcargo.ai/reference/expressions-cheatsheet.md): Essential JavaScript methods for using in your Cargo expressions - [Querying orchestration data](https://docs.getcargo.ai/reference/orchestration-query.md): Read-only ClickHouse SQL over your runs, batches, records and spans: the tables behind alert query scopes, the CLI and the API. - [Purchase Cargo credits](https://docs.getcargo.ai/reference/credits.md): Purchase credits for all enrichment, orchestration and storage actions on Cargo - [Chrome Extension overview](https://docs.getcargo.ai/reference/chrome-extension.md): Access Cargo agents and tools directly from your browser—inside your CRM, on any webpage, or anywhere you work. - [Overview](https://docs.getcargo.ai/reference/system-of-record.md): Set up and manage a system of record (SOR) — the authoritative synced copy of a source system you query and migrate from the CLI. - [Set up Cargo on Snowflake](https://docs.getcargo.ai/reference/system-of-record/snowflake.md): Configure Snowflake as your system of record in Cargo - [Set up Cargo on BigQuery](https://docs.getcargo.ai/reference/system-of-record/bigquery.md): Configure BigQuery as your system of record in Cargo - [Glossary](https://docs.getcargo.ai/reference/glossary.md): Definitions of key terms and concepts used throughout Cargo - [Security](https://docs.getcargo.ai/reference/security.md): How Cargo protects your data and keeps your workflows secure - [Overview](https://docs.getcargo.ai/integration/overview.md): Connect Cargo to your entire go-to-market stack - [Custom Integration](https://docs.getcargo.ai/integration/custom-integration.md): Build your own custom integration to connect any external service with Cargo. - [6sense](https://docs.getcargo.ai/integration/6sense.md): Connect 6sense Revenue AI Platform for lead scoring and firmographics in your workflows. - [Adyntel](https://docs.getcargo.ai/integration/adyntel.md): Connect Adyntel to retrieve ad library data across Google, Meta, and LinkedIn in your workflows. - [AI Ark](https://docs.getcargo.ai/integration/ai-ark.md): Connect AI Ark to source companies and people, enrich profiles, find verified emails and mobile phones in your workflows. - [Airscale](https://docs.getcargo.ai/integration/airscale.md): Connect Airscale to find people, phone numbers, and emails in your workflows. - [Albacross](https://docs.getcargo.ai/integration/albacross.md): Identify website visitors and enrich IP addresses with company data - [Amplitude](https://docs.getcargo.ai/integration/amplitude.md): Connect Amplitude to pull product analytics events into your workflows. - [Amplemarket](https://docs.getcargo.ai/integration/amplemarket.md): Connect Amplemarket for sales automation and outreach - [Anthropic](https://docs.getcargo.ai/integration/anthropic.md): This page outlines how to use the Anthropic integration for AI-powered actions in Cargo. - [Apify](https://docs.getcargo.ai/integration/apify.md): This page outlines how to use the Apify integration for web scraping and automation in Cargo. - [Anymail Finder](https://docs.getcargo.ai/integration/anymail-finder.md): Connect Anymail Finder to discover and verify email addresses in your workflows. - [Apollo.io](https://docs.getcargo.ai/integration/apolloio.md): Connect Apollo.io to enrich contacts, search prospects, and manage sales engagement in your workflows. - [Appfigures](https://docs.getcargo.ai/integration/appfigures.md): Search app store products and get revenue estimates with Appfigures - [Attio](https://docs.getcargo.ai/integration/attio.md): This page outlines how to use the Attio integration to pull and manage CRM data in Cargo. - [Azure OpenAI](https://docs.getcargo.ai/integration/azure-open-ai.md): This page outlines how to use the Azure OpenAI integration for AI-powered actions in Cargo. - [BetterContact](https://docs.getcargo.ai/integration/bettercontact.md): Connect BetterContact for waterfall enrichment to find emails and phones in your workflows. - [BigQuery](https://docs.getcargo.ai/integration/big-query.md): This page outlines how to use the BigQuery integration to create and manage your data warehouse in Cargo. - [Bouncer](https://docs.getcargo.ai/integration/bouncer.md): Connect Bouncer to verify email addresses with high accuracy in your workflows. - [Bright Data](https://docs.getcargo.ai/integration/bright-data.md): Connect Bright Data to scrape social media profiles and posts in your workflows. - [Calendly](https://docs.getcargo.ai/integration/calendly.md): This page outlines how to use the Calendly integration to track scheduling events in Cargo. - [Captain Data](https://docs.getcargo.ai/integration/captain-data.md): Connect Captain Data to run automation workflows and scraping jobs in your pipelines. - [Cargo](https://docs.getcargo.ai/integration/cargo.md): Source, match, enrich, and monitor businesses and prospects with Cargo's native B2B data. - [Clearbit](https://docs.getcargo.ai/integration/clearbit.md): This page outlines how to use the Clearbit integration for data enrichment in Cargo. - [ClearoutPhone](https://docs.getcargo.ai/integration/clearout-phone.md): Validate phone numbers with ClearoutPhone - [Cleon1](https://docs.getcargo.ai/integration/cleon1.md): Connect Cleon1 to find direct phone numbers in your workflows. - [Close](https://docs.getcargo.ai/integration/closecom.md): This page outlines how to use the Close integration to manage your sales CRM in Cargo. - [Cognism](https://docs.getcargo.ai/integration/cognism.md): Access premium B2B contact data with Cognism - [Company Enrich](https://docs.getcargo.ai/integration/company-enrich.md): Enrich companies and find similar companies with Company Enrich - [ContactOut](https://docs.getcargo.ai/integration/contact-out.md): Connect ContactOut to find contact information and search for people and companies in your workflows. - [Contrast](https://docs.getcargo.ai/integration/contrast.md): Track video engagement and registrations with Contrast - [Coresignal](https://docs.getcargo.ai/integration/coresignal.md): Access B2B company, member, and job data from Coresignal - [CSV](https://docs.getcargo.ai/integration/csv.md): Upload CSV files to import records into your Cargo data models. - [Customer.io](https://docs.getcargo.ai/integration/customerio.md): Connect Customer.io to manage customer messaging, segments, and event tracking in your workflows. - [Datachimp](https://docs.getcargo.ai/integration/datachimp.md): Track new hires and job offers with Datachimp - [Datagma](https://docs.getcargo.ai/integration/datagma.md): Connect Datagma to find emails and phone numbers in your workflows. - [dbt](https://docs.getcargo.ai/integration/dbt.md): Sync data from your dbt models into Cargo - [DeepSeek](https://docs.getcargo.ai/integration/deep-seek.md): Connect DeepSeek to use powerful AI models for text generation and reasoning in your workflows. - [Devin](https://docs.getcargo.ai/integration/devin.md): Launch Devin sessions to work on engineering tasks - [Dropcontact](https://docs.getcargo.ai/integration/dropcontact.md): Connect Dropcontact to find and verify professional email addresses in your workflows. - [Email Bison](https://docs.getcargo.ai/integration/email-bison.md): Connect Email Bison to create and manage leads in your cold email campaigns. - [EnrichCRM](https://docs.getcargo.ai/integration/enrich-crm.md): Find emails and enrich contacts and companies with EnrichCRM - [Enrichley](https://docs.getcargo.ai/integration/enrichley.md): Verify email addresses with Enrichley - [Enrow.io](https://docs.getcargo.ai/integration/enrowio.md): Connect Enrow.io to find and verify email addresses in your workflows. - [Exa](https://docs.getcargo.ai/integration/exa.md): Connect Exa to run AI-native web search in your Cargo workflows. - [Expandi.io](https://docs.getcargo.ai/integration/expandi.md): Add LinkedIn profiles to your Expandi outreach campaigns - [FindyMail](https://docs.getcargo.ai/integration/findy-mail.md): Connect FindyMail to find and verify email addresses in your workflows. - [Firecrawl](https://docs.getcargo.ai/integration/firecrawl.md): This page outlines how to use the Firecrawl integration for web scraping in Cargo. - [Forager](https://docs.getcargo.ai/integration/forager.md): Find personal emails and phone numbers with Forager - [FullEnrich](https://docs.getcargo.ai/integration/full-enrich.md): This page outlines how to use the FullEnrich integration to enrich for phones and emails in Cargo. - [G2](https://docs.getcargo.ai/integration/g2.md): Connect G2 to access product reviews, ratings, and software marketplace data in your workflows. - [Google Gemini](https://docs.getcargo.ai/integration/gemini.md): Connect Google Gemini to use Google's AI models for text generation and analysis in your workflows. - [GitHub](https://docs.getcargo.ai/integration/github.md): Connect GitHub to search repositories, contributors, and stargazers for developer-focused prospecting. - [Google Ads](https://docs.getcargo.ai/integration/google-ads.md): Push contacts into Google Ads Customer Match user lists for ad targeting and remarketing - [Google Sheets](https://docs.getcargo.ai/integration/google-sheets.md): This page outlines how to use the Google Sheets integration to read and write spreadsheet data in Cargo. - [HeyReach](https://docs.getcargo.ai/integration/hey-reach.md): Manage LinkedIn outreach campaigns with HeyReach - [HTTP](https://docs.getcargo.ai/integration/http.md): Connect to any API or webhook using the HTTP integration for custom integrations in your workflows. - [HubSpot](https://docs.getcargo.ai/integration/hubspot.md): This page outlines how to use the HubSpot integration to pull and manage CRM data in Cargo. - [HubSpot MCP](https://docs.getcargo.ai/integration/hubspot-mcp.md): Connect HubSpot's hosted MCP server so your AI agents can use HubSpot tools. - [Hunter](https://docs.getcargo.ai/integration/hunter.md): This page outlines how to use the Hunter integration for email finding and verification in Cargo. - [Icypeas](https://docs.getcargo.ai/integration/icypeas.md): Connect Icypeas to find and verify email addresses in your workflows. - [Instantly](https://docs.getcargo.ai/integration/instantly.md): Connect Instantly to manage cold email campaigns and leads in your workflows. - [Instantly](https://docs.getcargo.ai/integration/instantly-v2.md): Connect Instantly to manage leads and cold email campaigns in your workflows. - [Intercom](https://docs.getcargo.ai/integration/intercom.md): This page outlines how to use the Intercom integration to manage customer support contacts in Cargo. - [Jira](https://docs.getcargo.ai/integration/jira.md): This page outlines how to use the Jira integration for issue tracking in Cargo. - [Kaspr](https://docs.getcargo.ai/integration/kaspr.md): Connect Kaspr to enrich LinkedIn profiles with emails and phone numbers in your workflows. - [Kitt](https://docs.getcargo.ai/integration/kitt.md): Connect Kitt to verify email addresses in your workflows. - [LaGrowthMachine](https://docs.getcargo.ai/integration/lgm.md): Connect LaGrowthMachine to manage multi-channel sales outreach campaigns in your workflows. - [LeadMagic](https://docs.getcargo.ai/integration/lead-magic.md): Connect LeadMagic to enrich profiles and find email addresses in your workflows. - [Lemlist](https://docs.getcargo.ai/integration/lemlist.md): This page outlines how to use the Lemlist integration for sales outreach and email campaigns in Cargo. - [LinkedIn](https://docs.getcargo.ai/integration/linkedin.md): This page outlines how to use the LinkedIn integration for social selling, enrichment, and automation in Cargo. - [LinkedIn Ads](https://docs.getcargo.ai/integration/linkedin-ads.md): Fetch analytics data from your LinkedIn advertising campaigns - [LinkedIn Matched Audiences](https://docs.getcargo.ai/integration/linkedin-matched-audience.md): Push companies and contacts into LinkedIn Matched Audiences for ad targeting - [Linkup](https://docs.getcargo.ai/integration/linkup.md): Search the web and get AI-powered answers with Linkup - [Livestorm](https://docs.getcargo.ai/integration/livestorm.md): Connect Livestorm to pull webinar attendees and event data into your workflows. - [Lusha](https://docs.getcargo.ai/integration/lusha.md): Connect Lusha to enrich contacts and companies with verified contact information. - [Manus](https://docs.getcargo.ai/integration/manus.md): Run AI agent tasks with Manus - [Marketo](https://docs.getcargo.ai/integration/marketo.md): Connect Marketo to manage custom objects in your workflows. - [Metabase](https://docs.getcargo.ai/integration/metabase.md): Connect Metabase to run saved questions and SQL, sync question results into models, and give agents access to your Metabase. - [Microsoft Teams](https://docs.getcargo.ai/integration/microsoft-teams.md): Connect Microsoft Teams to send messages to channels and chats from your workflows. - [Mixpanel](https://docs.getcargo.ai/integration/mixpanel.md): Connect Mixpanel to pull product analytics events into your workflows. - [Mixrank](https://docs.getcargo.ai/integration/mixrank.md): Find people and companies with Mixrank B2B data - [NeverBounce](https://docs.getcargo.ai/integration/never-bounce.md): Connect NeverBounce to verify email addresses and maintain list hygiene in your workflows. - [NetSuite](https://docs.getcargo.ai/integration/netsuite.md): Connect your NetSuite ERP to sync and manage business records - [Notion MCP](https://docs.getcargo.ai/integration/notion-mcp.md): Connect Notion's hosted MCP server so your AI agents can search and update your Notion workspace. - [Ocean.io](https://docs.getcargo.ai/integration/oceanio.md): Connect Ocean.io for lookalike company discovery and contact enrichment in your workflows. - [Octave](https://docs.getcargo.ai/integration/octave.md): Run AI-powered sales agents with Octave - [OneSignal](https://docs.getcargo.ai/integration/onesignal.md): Connect OneSignal to send SMS messages in your workflows. - [OpenAI](https://docs.getcargo.ai/integration/open-ai.md): This page outlines how to use the OpenAI integration for AI-powered actions in Cargo. - [Outreach](https://docs.getcargo.ai/integration/outreach.md): This page outlines how to use the Outreach integration to manage sales engagement in Cargo. - [Parallel](https://docs.getcargo.ai/integration/parallel.md): Connect Parallel AI for web search, content extraction, and deep research tasks in your workflows. - [People Data Labs](https://docs.getcargo.ai/integration/people-data-labs.md): Connect People Data Labs for comprehensive person and company data enrichment and search. - [Perplexity](https://docs.getcargo.ai/integration/perplexity.md): Connect Perplexity AI to leverage internet-connected AI models for research and analysis in your workflows. - [Phantombuster](https://docs.getcargo.ai/integration/phantombuster.md): Connect Phantombuster to launch agents and sync their results in your workflows. - [Pipedrive](https://docs.getcargo.ai/integration/pipedrive.md): This page outlines how to use the Pipedrive integration to manage your sales CRM data in Cargo. - [Piloterr](https://docs.getcargo.ai/integration/piloterr.md): Build company lists with Piloterr's B2B database - [PostgreSQL](https://docs.getcargo.ai/integration/postgresql.md): This page outlines how to use the PostgreSQL integration to create and manage your database in Cargo. - [PredictLeads](https://docs.getcargo.ai/integration/predict-leads.md): Connect PredictLeads to access company intelligence, job openings, and technology data in your workflows. - [PromptLayer](https://docs.getcargo.ai/integration/prompt-layer.md): Run PromptLayer workflows for LLM-powered automation - [Prospeo](https://docs.getcargo.ai/integration/prospeo.md): Connect Prospeo to find emails, verify contacts, and enrich LinkedIn profiles in your workflows. - [ProxyCurl](https://docs.getcargo.ai/integration/proxycurl.md): Enrich and search LinkedIn data with ProxyCurl - [RB2B](https://docs.getcargo.ai/integration/rb2b.md): Identify website visitors with RB2B person-level identification - [Redshift](https://docs.getcargo.ai/integration/redshift.md): This page outlines how to use the Redshift integration to create and manage your data warehouse in Cargo. - [Replicas](https://docs.getcargo.ai/integration/replicas.md): Launch background coding agents in cloud workspaces - [Reverse Contact](https://docs.getcargo.ai/integration/reverse-contact.md): Connect Reverse Contact to enrich profiles and companies from email or LinkedIn in your workflows. - [Resend](https://docs.getcargo.ai/integration/resend.md): Connect Resend to send transactional emails from Cargo workflows. - [Rift](https://docs.getcargo.ai/integration/rift.md): Manage contacts and campaigns with Rift - [RocketReach](https://docs.getcargo.ai/integration/rocketreach.md): Connect RocketReach to find contact information and enrich person profiles in your workflows. - [RSS Feed](https://docs.getcargo.ai/integration/rss-feed.md): Connect to any RSS or Atom feed to ingest news, blogs, and updates into your workflows. - [Sales Navigator](https://docs.getcargo.ai/integration/sales-navigator.md): Access LinkedIn Sales Navigator data for prospecting - [Salesforce](https://docs.getcargo.ai/integration/salesforce.md): This page outlines how to use the Salesforce integration to pull and manage CRM data in Cargo. - [Salesforce MCP](https://docs.getcargo.ai/integration/salesforce-mcp.md): Connect a Salesforce hosted MCP server so your AI agents can use Salesforce tools. - [SalesIntel](https://docs.getcargo.ai/integration/sales-intel.md): Access B2B company data with SalesIntel - [Salesloft](https://docs.getcargo.ai/integration/salesloft.md): Connect Salesloft to manage sales engagement, accounts, and people in your workflows. - [Scrubby](https://docs.getcargo.ai/integration/scrubby.md): Verify email addresses with Scrubby - [SendGrid](https://docs.getcargo.ai/integration/sendgrid.md): This page outlines how to use the SendGrid integration for transactional email in Cargo. - [Serper](https://docs.getcargo.ai/integration/serper.md): Connect Serper to search Google and find places in your workflows. - [Slack](https://docs.getcargo.ai/integration/slack.md): This page outlines how to use the Slack integration to send messages and notifications from Cargo. - [Smartlead.ai](https://docs.getcargo.ai/integration/smartlead.md): Connect Smartlead.ai to manage cold email campaigns and leads in your workflows. - [Snitcher](https://docs.getcargo.ai/integration/snitcher.md): Identify website visitors and track sessions with Snitcher - [Snov.io](https://docs.getcargo.ai/integration/snov.md): Connect Snov.io to find emails, verify addresses, and enrich profiles in your workflows. - [Societe Info](https://docs.getcargo.ai/integration/societe-info.md): Access French company and contact data with Societe Info - [Snowflake](https://docs.getcargo.ai/integration/snowflake.md): This page outlines how to use the Snowflake integration to create and manage your data warehouse in Cargo. - [SQL](https://docs.getcargo.ai/integration/sql.md): Connect to SQL databases for direct data access and manipulation - [Store Leads](https://docs.getcargo.ai/integration/storeleads.md): Enrich e-commerce store data with Store Leads - [Stripe](https://docs.getcargo.ai/integration/stripe.md): This page outlines how to use the Stripe integration to manage payment data in Cargo. - [Sumble](https://docs.getcargo.ai/integration/sumble.md): Connect Sumble to discover companies, jobs, and people by technology stack in your workflows. - [Surfe](https://docs.getcargo.ai/integration/surfe.md): Connect Surfe to search and enrich people and companies in your workflows. - [TheirStack](https://docs.getcargo.ai/integration/their-stack.md): Connect TheirStack to discover companies and job postings by technology stack in your workflows. - [Theneo](https://docs.getcargo.ai/integration/theneo.md): Verify email addresses with Theneo - [The Swarm](https://docs.getcargo.ai/integration/the-swarm.md): Find warm introductions to target companies and people - [Waterfall.io](https://docs.getcargo.ai/integration/waterfall.md): Enrich contacts and find prospects with Waterfall.io - [Wiza](https://docs.getcargo.ai/integration/wiza.md): Connect Wiza to enrich contact profiles with emails and phone numbers in your workflows. - [ZeroBounce](https://docs.getcargo.ai/integration/zero-bounce.md): Connect ZeroBounce to verify email addresses and improve deliverability in your workflows. - [ZoomInfo](https://docs.getcargo.ai/integration/zoominfo.md): Access B2B contact and company data with ZoomInfo - [Changelog](https://docs.getcargo.ai/changelog.md): Week-by-week summary of new features, integrations, and improvements - [API Reference](https://docs.getcargo.ai/api-reference/introduction.md): Complete reference for the Cargo REST API - [Create agent](https://docs.getcargo.ai/api-reference/ai--agents/create-agent.md): Create a new AI agent - [List agents](https://docs.getcargo.ai/api-reference/ai--agents/list-agents.md): List all AI agents in the workspace - [Get agent](https://docs.getcargo.ai/api-reference/ai--agents/get-agent.md): Get an AI agent by UUID - [Update agent](https://docs.getcargo.ai/api-reference/ai--agents/update-agent.md): Update an AI agent - [Remove agent](https://docs.getcargo.ai/api-reference/ai--agents/remove-agent.md): Remove an AI agent - [Create chat](https://docs.getcargo.ai/api-reference/ai--chats/create-chat.md): Create a new chat session - [List chats](https://docs.getcargo.ai/api-reference/ai--chats/list-chats.md): List all chat sessions - [Get chat](https://docs.getcargo.ai/api-reference/ai--chats/get-chat.md): Get a chat session by UUID - [Update chat](https://docs.getcargo.ai/api-reference/ai--chats/update-chat.md): Update a chat session - [Remove chat](https://docs.getcargo.ai/api-reference/ai--chats/remove-chat.md): Remove a chat session - [Create document](https://docs.getcargo.ai/api-reference/ai--documents/create-document.md): Create a new AI document - [List documents](https://docs.getcargo.ai/api-reference/ai--documents/list-documents.md): List all AI documents - [Get document](https://docs.getcargo.ai/api-reference/ai--documents/get-document.md): Get an AI document by UUID - [Reset document](https://docs.getcargo.ai/api-reference/ai--documents/reset-document.md): Reset an AI document - [Evaluate](https://docs.getcargo.ai/api-reference/ai--evaluator/evaluate.md): Run an AI evaluator - [Connect MCP client](https://docs.getcargo.ai/api-reference/ai--mcp/connect-mcp-client.md): Connect to an MCP client - [Create MCP server](https://docs.getcargo.ai/api-reference/ai--mcp/create-mcp-server.md): Create a new MCP server - [List MCP servers](https://docs.getcargo.ai/api-reference/ai--mcp/list-mcp-servers.md): List all MCP servers - [Get MCP server](https://docs.getcargo.ai/api-reference/ai--mcp/get-mcp-server.md): Get an MCP server by UUID - [Update MCP server](https://docs.getcargo.ai/api-reference/ai--mcp/update-mcp-server.md): Update an MCP server - [Remove MCP server](https://docs.getcargo.ai/api-reference/ai--mcp/remove-mcp-server.md): Remove an MCP server - [List memories](https://docs.getcargo.ai/api-reference/ai--memories/list-memories.md): List all AI memories. Query params: scope (user|agent), agentUuid (required when scope=agent) - [Update memory](https://docs.getcargo.ai/api-reference/ai--memories/update-memory.md): Update an AI memory - [Remove memory](https://docs.getcargo.ai/api-reference/ai--memories/remove-memory.md): Remove an AI memory. Query params: scope (user|agent), agentUuid (required when scope=agent) - [Create message](https://docs.getcargo.ai/api-reference/ai--messages/create-message.md): Create a new message in a chat. Returns the user message and a pending assistant message. The assistant response is processed asynchronously. - [Get message](https://docs.getcargo.ai/api-reference/ai--messages/get-message.md): Get a message by UUID - [Remove message](https://docs.getcargo.ai/api-reference/ai--messages/remove-message.md): Remove a message from a chat - [List messages](https://docs.getcargo.ai/api-reference/ai--messages/list-messages.md): List all messages in a chat - [Stream message](https://docs.getcargo.ai/api-reference/ai--messages/stream-message.md): Stream a new message in a chat - [Resume message stream](https://docs.getcargo.ai/api-reference/ai--messages/resume-message-stream.md): Resume streaming a message - [Cancel messages](https://docs.getcargo.ai/api-reference/ai--messages/cancel-messages.md): Cancel messages that have associated Temporal workflows (workflow-backed messages). Skips messages that have no workflow or are already finished. - [Evaluate prompt](https://docs.getcargo.ai/api-reference/ai--prompts/evaluate-prompt.md): Evaluate an AI prompt - [Optimize prompt](https://docs.getcargo.ai/api-reference/ai--prompts/optimize-prompt.md): Optimize an AI prompt - [Generate prompt JSON schema](https://docs.getcargo.ai/api-reference/ai--prompts/generate-prompt-json-schema.md): Generate a JSON schema for the output of an AI prompt - [Deploy draft release](https://docs.getcargo.ai/api-reference/ai--releases/deploy-draft-release.md): Deploy a draft release - [List releases](https://docs.getcargo.ai/api-reference/ai--releases/list-releases.md): List all releases - [Get draft release](https://docs.getcargo.ai/api-reference/ai--releases/get-draft-release.md): Get the draft release - [Get deployed release](https://docs.getcargo.ai/api-reference/ai--releases/get-deployed-release.md): Get the deployed release - [Get release](https://docs.getcargo.ai/api-reference/ai--releases/get-release.md): Get a release by UUID - [Update draft release](https://docs.getcargo.ai/api-reference/ai--releases/update-draft-release.md): Update the draft release - [Generate suggested actions](https://docs.getcargo.ai/api-reference/ai--suggested-actions/generate-suggested-actions.md): Generate suggested actions for a chat - [List templates](https://docs.getcargo.ai/api-reference/ai--templates/list-templates.md): List all AI templates - [Get template](https://docs.getcargo.ai/api-reference/ai--templates/get-template.md): Get an AI template by slug - [Get template documentation](https://docs.getcargo.ai/api-reference/ai--templates/get-template-documentation.md): Get the documentation for an AI template - [List votes](https://docs.getcargo.ai/api-reference/ai--votes/list-votes.md): List all votes - [Upsert vote](https://docs.getcargo.ai/api-reference/ai--votes/upsert-vote.md): Create or update a vote - [Get subscription](https://docs.getcargo.ai/api-reference/billing--subscription/get-subscription.md): Get the current workspace subscription - [Get credit card](https://docs.getcargo.ai/api-reference/billing--subscription/get-credit-card.md): Get the credit card on file - [Get invoices](https://docs.getcargo.ai/api-reference/billing--subscription/get-invoices.md): Get subscription invoices - [Create portal session](https://docs.getcargo.ai/api-reference/billing--subscription/create-portal-session.md): Create a Stripe customer portal session - [Get Stripe publishable key](https://docs.getcargo.ai/api-reference/billing--subscription/get-stripe-publishable-key.md): Get the Stripe publishable key for tokenizing a card - [Create payment method portal session](https://docs.getcargo.ai/api-reference/billing--subscription/create-payment-method-portal-session.md): Create a Stripe portal session that opens directly on the card form - [Create setup intent](https://docs.getcargo.ai/api-reference/billing--subscription/create-setup-intent.md): Create a Stripe setup intent for adding payment method - [Update credits overage behaviors](https://docs.getcargo.ai/api-reference/billing--subscription/update-credits-overage-behaviors.md): Update the credits overage behaviors settings - [Update payment method](https://docs.getcargo.ai/api-reference/billing--subscription/update-payment-method.md): Update the payment method on file - [Update plan](https://docs.getcargo.ai/api-reference/billing--subscription/update-plan.md): Update the subscription plan - [Update topup](https://docs.getcargo.ai/api-reference/billing--subscription/update-topup.md): Update the automatic topup settings - [Get usage metrics](https://docs.getcargo.ai/api-reference/billing--usage/get-usage-metrics.md): Get usage metrics for the workspace - [Create connector](https://docs.getcargo.ai/api-reference/connection--connectors/create-connector.md): Create a new connector - [List connectors](https://docs.getcargo.ai/api-reference/connection--connectors/list-connectors.md): List all connectors in the workspace - [Autocomplete connectors](https://docs.getcargo.ai/api-reference/connection--connectors/autocomplete-connectors.md): Get connector autocomplete suggestions - [Check connector exists by slug](https://docs.getcargo.ai/api-reference/connection--connectors/check-connector-exists-by-slug.md): Check if a connector exists by its slug - [Get connector](https://docs.getcargo.ai/api-reference/connection--connectors/get-connector.md): Get a connector by UUID - [Update connector](https://docs.getcargo.ai/api-reference/connection--connectors/update-connector.md): Update a connector - [Remove connector](https://docs.getcargo.ai/api-reference/connection--connectors/remove-connector.md): Remove a connector - [Get dynamic schema](https://docs.getcargo.ai/api-reference/connection--connectors/get-dynamic-schema.md): Get dynamic schema for a connector - [Get language models](https://docs.getcargo.ai/api-reference/connection--connectors/get-language-models.md): Get the language models available for a connector - [Create custom integration](https://docs.getcargo.ai/api-reference/connection--custom-integrations/create-custom-integration.md): Create a new custom integration - [List custom integrations](https://docs.getcargo.ai/api-reference/connection--custom-integrations/list-custom-integrations.md): List all custom integrations - [Get custom integration](https://docs.getcargo.ai/api-reference/connection--custom-integrations/get-custom-integration.md): Get a custom integration by UUID - [Update custom integration](https://docs.getcargo.ai/api-reference/connection--custom-integrations/update-custom-integration.md): Update a custom integration - [Remove custom integration](https://docs.getcargo.ai/api-reference/connection--custom-integrations/remove-custom-integration.md): Remove a custom integration - [List integrations](https://docs.getcargo.ai/api-reference/connection--integrations/list-integrations.md): List all available integrations - [Get integration](https://docs.getcargo.ai/api-reference/connection--integrations/get-integration.md): Get an integration by slug - [Get integration documentation](https://docs.getcargo.ai/api-reference/connection--integrations/get-integration-documentation.md): Get the documentation for an integration - [Complete OAuth](https://docs.getcargo.ai/api-reference/connection--integrations/complete-oauth.md): Complete OAuth flow for an integration - [Initiate OAuth](https://docs.getcargo.ai/api-reference/connection--integrations/initiate-oauth.md): Initiate the OAuth flow for an integration and return a consent URL. - [Get native integration](https://docs.getcargo.ai/api-reference/connection--native-integrations/get-native-integration.md): Get the native integration - [Upload file](https://docs.getcargo.ai/api-reference/content--files/upload-file.md): Upload a workspace file for RAG and agent resources - [List files](https://docs.getcargo.ai/api-reference/content--files/list-files.md): List workspace files - [Get file](https://docs.getcargo.ai/api-reference/content--files/get-file.md): Get a workspace file by UUID - [Update file](https://docs.getcargo.ai/api-reference/content--files/update-file.md): Update a workspace file - [Remove file](https://docs.getcargo.ai/api-reference/content--files/remove-file.md): Remove a workspace file - [Get file bytes](https://docs.getcargo.ai/api-reference/content--files/get-file-bytes.md): Stream a workspace file's raw bytes for inline preview (capped at 10 MB) - [Create library](https://docs.getcargo.ai/api-reference/content--libraries/create-library.md): Create a connector file library - [List libraries](https://docs.getcargo.ai/api-reference/content--libraries/list-libraries.md): List workspace libraries - [Get library](https://docs.getcargo.ai/api-reference/content--libraries/get-library.md): Get a workspace library by UUID - [Remove library](https://docs.getcargo.ai/api-reference/content--libraries/remove-library.md): Remove a workspace library - [Update library](https://docs.getcargo.ai/api-reference/content--libraries/update-library.md): Update a workspace library - [Get context graph](https://docs.getcargo.ai/api-reference/context--graph/get-context-graph.md): Get the knowledge graph of the workspace context repository: nodes for markdown files and edges for links between them. - [Get context repository](https://docs.getcargo.ai/api-reference/context--repository/get-context-repository.md): Get the context repository configuration for the current workspace. - [Browse runtime sandbox](https://docs.getcargo.ai/api-reference/context--runtime/browse-runtime-sandbox.md): List entries at a path in the workspace runtime sandbox. Omit `path` to list the root, or pass `depth=-1` (with no `path`) to fetch the entire repository tree from the configured default branch on GitHub in one call. - [Read runtime sandbox file as raw bytes](https://docs.getcargo.ai/api-reference/context--runtime/read-runtime-sandbox-file-as-raw-bytes.md): Stream the raw bytes of a file from the workspace context repository's default branch on GitHub, with a resolved `Content-Type` header. Used by the file viewer for binary previews (images, PDFs). - [Write runtime sandbox file](https://docs.getcargo.ai/api-reference/context--runtime/write-runtime-sandbox-file.md): Create or overwrite a file in the workspace runtime sandbox and push the change to the workspace's default branch on GitHub. - [Read runtime sandbox file](https://docs.getcargo.ai/api-reference/context--runtime/read-runtime-sandbox-file.md): Read a UTF-8 file from the workspace runtime sandbox. Returns the file content. - [Edit runtime sandbox file](https://docs.getcargo.ai/api-reference/context--runtime/edit-runtime-sandbox-file.md): Replace occurrences of `oldString` with `newString` in a file in the workspace runtime sandbox, then push the change to the workspace's default branch on GitHub. By default `oldString` must occur exactly once; pass `replaceAll: true` to replace every occurrence. - [Execute in runtime sandbox](https://docs.getcargo.ai/api-reference/context--runtime/execute-in-runtime-sandbox.md): Run a shell command in the workspace runtime sandbox. Tracked working-tree changes the command produced (additions, edits, deletions, renames) are auto-committed and pushed to the workspace's default branch as a single commit. Pass `commitMessage` to customize the commit subject; gitignored paths ar… - [List domains](https://docs.getcargo.ai/api-reference/domain-management--domains/list-domains.md): List the workspace's managed domains - [Purchase domain](https://docs.getcargo.ai/api-reference/domain-management--domains/purchase-domain.md): Purchase a domain; charged in workspace credits - [Search domain](https://docs.getcargo.ai/api-reference/domain-management--domains/search-domain.md): Check a domain name's availability and price in credits (exact match) - [Get domain suggestions](https://docs.getcargo.ai/api-reference/domain-management--domains/get-domain-suggestions.md): Get purchasable alternative domain names for a search - [Get domain](https://docs.getcargo.ai/api-reference/domain-management--domains/get-domain.md): Get a managed domain by UUID - [Cancel domain](https://docs.getcargo.ai/api-reference/domain-management--domains/cancel-domain.md): Cancel a managed domain; credits are not refunded - [List DNS records](https://docs.getcargo.ai/api-reference/domain-management--domains/list-dns-records.md): List a managed domain's DNS records - [Set DNS records](https://docs.getcargo.ai/api-reference/domain-management--domains/set-dns-records.md): Replace a managed domain's DNS records - [Refresh domain status](https://docs.getcargo.ai/api-reference/domain-management--domains/refresh-domain-status.md): Re-poll the registrar for a managed domain's status - [Evaluate expression](https://docs.getcargo.ai/api-reference/expression--expressions/evaluate-expression.md): Evaluate a formula expression - [Generate expression](https://docs.getcargo.ai/api-reference/expression--expressions/generate-expression.md): Generate an expression using AI - [Create recipe](https://docs.getcargo.ai/api-reference/expression--recipes/create-recipe.md): Create a new expression recipe - [List recipes](https://docs.getcargo.ai/api-reference/expression--recipes/list-recipes.md): List all expression recipes - [Get recipe](https://docs.getcargo.ai/api-reference/expression--recipes/get-recipe.md): Get a recipe by UUID or short ID and version - [Get last version](https://docs.getcargo.ai/api-reference/expression--recipes/get-last-version.md): Get the last version of a recipe - [Create new version](https://docs.getcargo.ai/api-reference/expression--recipes/create-new-version.md): Create a new version of a recipe - [Archive recipe](https://docs.getcargo.ai/api-reference/expression--recipes/archive-recipe.md): Archive an expression recipe - [Create favorite recipe](https://docs.getcargo.ai/api-reference/expression--favorite-recipes/create-favorite-recipe.md): Add a recipe to favorites - [Remove favorite recipe](https://docs.getcargo.ai/api-reference/expression--favorite-recipes/remove-favorite-recipe.md): Remove a recipe from favorites - [Create app](https://docs.getcargo.ai/api-reference/hosting--apps/create-app.md): Create a new hosted app - [List apps](https://docs.getcargo.ai/api-reference/hosting--apps/list-apps.md): List hosted apps in the workspace - [Get app](https://docs.getcargo.ai/api-reference/hosting--apps/get-app.md): Get a hosted app by UUID - [Update app](https://docs.getcargo.ai/api-reference/hosting--apps/update-app.md): Update a hosted app - [Remove app](https://docs.getcargo.ai/api-reference/hosting--apps/remove-app.md): Remove a hosted app - [Create worker](https://docs.getcargo.ai/api-reference/hosting--workers/create-worker.md): Create a new hosted worker - [List workers](https://docs.getcargo.ai/api-reference/hosting--workers/list-workers.md): List hosted workers in the workspace - [Get worker](https://docs.getcargo.ai/api-reference/hosting--workers/get-worker.md): Get a hosted worker by UUID - [Update worker](https://docs.getcargo.ai/api-reference/hosting--workers/update-worker.md): Update a hosted worker - [Remove worker](https://docs.getcargo.ai/api-reference/hosting--workers/remove-worker.md): Remove a hosted worker - [Create deployment](https://docs.getcargo.ai/api-reference/hosting--deployments/create-deployment.md): Create a new deployment for an app or worker - [List deployments](https://docs.getcargo.ai/api-reference/hosting--deployments/list-deployments.md): List deployments for an app or worker - [Count deployments](https://docs.getcargo.ai/api-reference/hosting--deployments/count-deployments.md): Count deployments for an app or worker - [Get promoted deployment](https://docs.getcargo.ai/api-reference/hosting--deployments/get-promoted-deployment.md): Get the currently promoted deployment for an app or worker - [Promote deployment](https://docs.getcargo.ai/api-reference/hosting--deployments/promote-deployment.md): Promote a deployment to serve live traffic - [Cancel deployment](https://docs.getcargo.ai/api-reference/hosting--deployments/cancel-deployment.md): Cancel an in-progress deployment - [Get deployment](https://docs.getcargo.ai/api-reference/hosting--deployments/get-deployment.md): Get a deployment by UUID - [Get deployment build log URL](https://docs.getcargo.ai/api-reference/hosting--deployments/get-deployment-build-log-url.md): Get a signed URL to download a deployment's build log - [Get deployment source archive URL](https://docs.getcargo.ai/api-reference/hosting--deployments/get-deployment-source-archive-url.md): Get a signed URL to download a deployment's source archive - [List env vars](https://docs.getcargo.ai/api-reference/hosting--env-vars/list-env-vars.md): List environment variables for an app or worker - [Create env var](https://docs.getcargo.ai/api-reference/hosting--env-vars/create-env-var.md): Create an environment variable for an app or worker - [Remove env var](https://docs.getcargo.ai/api-reference/hosting--env-vars/remove-env-var.md): Remove an environment variable - [Update env var](https://docs.getcargo.ai/api-reference/hosting--env-vars/update-env-var.md): Update an environment variable - [List custom domains](https://docs.getcargo.ai/api-reference/hosting--custom-domains/list-custom-domains.md): List custom domains attached to an app or worker - [Attach custom domain](https://docs.getcargo.ai/api-reference/hosting--custom-domains/attach-custom-domain.md): Attach a custom domain to an app or worker - [Get custom domain](https://docs.getcargo.ai/api-reference/hosting--custom-domains/get-custom-domain.md): Get a custom domain by UUID - [Detach custom domain](https://docs.getcargo.ai/api-reference/hosting--custom-domains/detach-custom-domain.md): Detach a custom domain from an app or worker - [Refresh custom domain status](https://docs.getcargo.ai/api-reference/hosting--custom-domains/refresh-custom-domain-status.md): Re-poll the provider for a custom domain's status - [Execute action](https://docs.getcargo.ai/api-reference/orchestration--actions/execute-action.md): Execute an orchestration action - [Execute action batch](https://docs.getcargo.ai/api-reference/orchestration--actions/execute-action-batch.md): Execute an orchestration action as a batch - [Get action output schema](https://docs.getcargo.ai/api-reference/orchestration--actions/get-action-output-schema.md): Get the output schema of an orchestration action - [Create batch](https://docs.getcargo.ai/api-reference/orchestration--batches/create-batch.md): Create a new orchestration batch - [List batches](https://docs.getcargo.ai/api-reference/orchestration--batches/list-batches.md): List all orchestration batches - [Get batch](https://docs.getcargo.ai/api-reference/orchestration--batches/get-batch.md): Get an orchestration batch by UUID - [Cancel batch](https://docs.getcargo.ai/api-reference/orchestration--batches/cancel-batch.md): Cancel a running batch - [Download batch](https://docs.getcargo.ai/api-reference/orchestration--batches/download-batch.md): Download batch results - [Preview batch](https://docs.getcargo.ai/api-reference/orchestration--batches/preview-batch.md): Preview batch data before execution - [Compute node](https://docs.getcargo.ai/api-reference/orchestration--nodes/compute-node.md): Compute node output - [Execute node](https://docs.getcargo.ai/api-reference/orchestration--nodes/execute-node.md): Execute a node - [Validate nodes](https://docs.getcargo.ai/api-reference/orchestration--nodes/validate-nodes.md): Validate orchestration nodes - [Create play](https://docs.getcargo.ai/api-reference/orchestration--plays/create-play.md): Create a new play - [List plays](https://docs.getcargo.ai/api-reference/orchestration--plays/list-plays.md): List all plays - [Get play](https://docs.getcargo.ai/api-reference/orchestration--plays/get-play.md): Get a play by UUID - [Update play](https://docs.getcargo.ai/api-reference/orchestration--plays/update-play.md): Update a play - [Remove play](https://docs.getcargo.ai/api-reference/orchestration--plays/remove-play.md): Remove a play - [List spans](https://docs.getcargo.ai/api-reference/orchestration--spans/list-spans.md): List flattened execution spans for orchestration runs (one row per executed node within a run) - [Count spans](https://docs.getcargo.ai/api-reference/orchestration--spans/count-spans.md): Count orchestration execution spans - [Execute SQL query](https://docs.getcargo.ai/api-reference/orchestration--query/execute-sql-query.md): Execute a read-only SQL query against orchestration ClickHouse tables (spans, runs, batches, records). - [List records](https://docs.getcargo.ai/api-reference/orchestration--records/list-records.md): List orchestration records - [Count records](https://docs.getcargo.ai/api-reference/orchestration--records/count-records.md): Count orchestration records - [Download records](https://docs.getcargo.ai/api-reference/orchestration--records/download-records.md): Download orchestration records - [Download record outputs](https://docs.getcargo.ai/api-reference/orchestration--records/download-record-outputs.md): Download orchestration record outputs with input and output node contexts - [Get record metrics](https://docs.getcargo.ai/api-reference/orchestration--records/get-record-metrics.md): Get metrics for orchestration records - [Cancel records](https://docs.getcargo.ai/api-reference/orchestration--records/cancel-records.md): Cancel running orchestration records - [Deploy draft release](https://docs.getcargo.ai/api-reference/orchestration--releases/deploy-draft-release.md): Deploy a draft release - [List releases](https://docs.getcargo.ai/api-reference/orchestration--releases/list-releases.md): List all releases - [Get draft release](https://docs.getcargo.ai/api-reference/orchestration--releases/get-draft-release.md): Get the draft release - [Get deployed release](https://docs.getcargo.ai/api-reference/orchestration--releases/get-deployed-release.md): Get the deployed release - [Get release](https://docs.getcargo.ai/api-reference/orchestration--releases/get-release.md): Get a release by UUID - [Update draft release](https://docs.getcargo.ai/api-reference/orchestration--releases/update-draft-release.md): Update the draft release - [Create run](https://docs.getcargo.ai/api-reference/orchestration--runs/create-run.md): Create a new orchestration run - [List runs](https://docs.getcargo.ai/api-reference/orchestration--runs/list-runs.md): List orchestration runs - [Count runs](https://docs.getcargo.ai/api-reference/orchestration--runs/count-runs.md): Count orchestration runs - [Download runs](https://docs.getcargo.ai/api-reference/orchestration--runs/download-runs.md): Download orchestration runs - [Download run outputs](https://docs.getcargo.ai/api-reference/orchestration--runs/download-run-outputs.md): Download orchestration run outputs with input and output node contexts - [Get run metrics](https://docs.getcargo.ai/api-reference/orchestration--runs/get-run-metrics.md): Get metrics for orchestration runs - [Get run](https://docs.getcargo.ai/api-reference/orchestration--runs/get-run.md): Get an orchestration run by UUID - [Cancel runs](https://docs.getcargo.ai/api-reference/orchestration--runs/cancel-runs.md): Cancel running orchestration runs - [List templates](https://docs.getcargo.ai/api-reference/orchestration--templates/list-templates.md): List all orchestration templates - [Get template](https://docs.getcargo.ai/api-reference/orchestration--templates/get-template.md): Get an orchestration template by slug - [Get template documentation](https://docs.getcargo.ai/api-reference/orchestration--templates/get-template-documentation.md): Get the documentation for an orchestration template - [Create tool](https://docs.getcargo.ai/api-reference/orchestration--tools/create-tool.md): Create a new tool - [List tools](https://docs.getcargo.ai/api-reference/orchestration--tools/list-tools.md): List all tools - [Get tool](https://docs.getcargo.ai/api-reference/orchestration--tools/get-tool.md): Get a tool by UUID - [Update tool](https://docs.getcargo.ai/api-reference/orchestration--tools/update-tool.md): Update a tool - [Remove tool](https://docs.getcargo.ai/api-reference/orchestration--tools/remove-tool.md): Remove a tool - [List traces](https://docs.getcargo.ai/api-reference/orchestration--traces/list-traces.md): List orchestration traces. Each trace wraps every span (node execution) across its run lineage; the summary is aggregated at query time directly from orchestration.spans (no separate traces table — spans carries `trace_uuid` with a bloom-filter skipping index). - [Count traces](https://docs.getcargo.ai/api-reference/orchestration--traces/count-traces.md): Count orchestration traces matching the filter. - [Get trace](https://docs.getcargo.ai/api-reference/orchestration--traces/get-trace.md): Get a single orchestration trace by UUID. - [List workflows](https://docs.getcargo.ai/api-reference/orchestration--workflows/list-workflows.md): List all workflows - [Get workflow](https://docs.getcargo.ai/api-reference/orchestration--workflows/get-workflow.md): Get a workflow by UUID - [List allocations](https://docs.getcargo.ai/api-reference/revenue-organization--allocations/list-allocations.md): List all allocations - [Get allocation](https://docs.getcargo.ai/api-reference/revenue-organization--allocations/get-allocation.md): Get an allocation by UUID - [Remove allocation](https://docs.getcargo.ai/api-reference/revenue-organization--allocations/remove-allocation.md): Remove an allocation - [Sync allocations](https://docs.getcargo.ai/api-reference/revenue-organization--allocations/sync-allocations.md): Sync allocations from external source - [Create capacity](https://docs.getcargo.ai/api-reference/revenue-organization--capacities/create-capacity.md): Create a new capacity - [List capacities](https://docs.getcargo.ai/api-reference/revenue-organization--capacities/list-capacities.md): List all capacities - [Get capacity](https://docs.getcargo.ai/api-reference/revenue-organization--capacities/get-capacity.md): Get a capacity by UUID - [Update capacity](https://docs.getcargo.ai/api-reference/revenue-organization--capacities/update-capacity.md): Update a capacity - [Remove capacity](https://docs.getcargo.ai/api-reference/revenue-organization--capacities/remove-capacity.md): Remove a capacity - [List members](https://docs.getcargo.ai/api-reference/revenue-organization--members/list-members.md): List all members - [Get member](https://docs.getcargo.ai/api-reference/revenue-organization--members/get-member.md): Get a member by UUID - [Update member](https://docs.getcargo.ai/api-reference/revenue-organization--members/update-member.md): Update a member - [Sync members](https://docs.getcargo.ai/api-reference/revenue-organization--members/sync-members.md): Sync members from external source - [Archive member](https://docs.getcargo.ai/api-reference/revenue-organization--members/archive-member.md): Archive a member - [Unarchive member](https://docs.getcargo.ai/api-reference/revenue-organization--members/unarchive-member.md): Unarchive a member - [Create territory](https://docs.getcargo.ai/api-reference/revenue-organization--territories/create-territory.md): Create a new territory - [List territories](https://docs.getcargo.ai/api-reference/revenue-organization--territories/list-territories.md): List all territories - [Get territory](https://docs.getcargo.ai/api-reference/revenue-organization--territories/get-territory.md): Get a territory by UUID - [Update territory](https://docs.getcargo.ai/api-reference/revenue-organization--territories/update-territory.md): Update a territory - [Remove territory](https://docs.getcargo.ai/api-reference/revenue-organization--territories/remove-territory.md): Remove a territory - [List changes](https://docs.getcargo.ai/api-reference/segmentation--changes/list-changes.md): List all segment changes - [Get change](https://docs.getcargo.ai/api-reference/segmentation--changes/get-change.md): Get a segment change by UUID - [Fetch change data](https://docs.getcargo.ai/api-reference/segmentation--changes/fetch-change-data.md): Fetch data for a segment change - [Download change data](https://docs.getcargo.ai/api-reference/segmentation--changes/download-change-data.md): Download data for a segment change - [Fetch records](https://docs.getcargo.ai/api-reference/segmentation--records/fetch-records.md): Fetch segmentation records - [Create segment](https://docs.getcargo.ai/api-reference/segmentation--segments/create-segment.md): Create a new segment - [List segments](https://docs.getcargo.ai/api-reference/segmentation--segments/list-segments.md): List all segments - [Get segment](https://docs.getcargo.ai/api-reference/segmentation--segments/get-segment.md): Get a segment by UUID - [Update segment](https://docs.getcargo.ai/api-reference/segmentation--segments/update-segment.md): Update a segment - [Remove segment](https://docs.getcargo.ai/api-reference/segmentation--segments/remove-segment.md): Remove a segment - [Fetch segment data](https://docs.getcargo.ai/api-reference/segmentation--segments/fetch-segment-data.md): Fetch data for a segment - [Download segment data](https://docs.getcargo.ai/api-reference/segmentation--segments/download-segment-data.md): Download data for a segment - [Get segment metrics](https://docs.getcargo.ai/api-reference/segmentation--segments/get-segment-metrics.md): Get metrics for a segment - [Update column](https://docs.getcargo.ai/api-reference/storage--columns/update-column.md): Update a column by UUID - [Create column](https://docs.getcargo.ai/api-reference/storage--columns/create-column.md): Create a new column for a model - [Remove column](https://docs.getcargo.ai/api-reference/storage--columns/remove-column.md): Remove a column by UUID - [List model columns](https://docs.getcargo.ai/api-reference/storage--columns/list-model-columns.md): List all columns for a model, using prefixed slugs for additional columns - [Autocomplete columns](https://docs.getcargo.ai/api-reference/storage--columns/autocomplete-columns.md): Get column autocomplete suggestions - [Check column exists by slug](https://docs.getcargo.ai/api-reference/storage--columns/check-column-exists-by-slug.md): Check if a column exists by its slug - [Reorder columns](https://docs.getcargo.ai/api-reference/storage--columns/reorder-columns.md): Reorder columns for a model - [Insert custom column values](https://docs.getcargo.ai/api-reference/storage--columns/insert-custom-column-values.md): Set custom column values on a single record. Original object fields are not accepted; use record create/update for those. - [Insert custom column values (bulk)](https://docs.getcargo.ai/api-reference/storage--columns/insert-custom-column-values-bulk.md): Set custom column values on multiple records. Original object fields are not accepted; use record create/update for those. - [List datasets](https://docs.getcargo.ai/api-reference/storage--datasets/list-datasets.md): List all datasets in the workspace - [Get dataset](https://docs.getcargo.ai/api-reference/storage--datasets/get-dataset.md): Get a dataset by UUID - [Create model](https://docs.getcargo.ai/api-reference/storage--models/create-model.md): Create a new model - [List models](https://docs.getcargo.ai/api-reference/storage--models/list-models.md): List all models in the workspace - [Check model exists by slug](https://docs.getcargo.ai/api-reference/storage--models/check-model-exists-by-slug.md): Check if a model exists by its slug - [Get model](https://docs.getcargo.ai/api-reference/storage--models/get-model.md): Get a model by UUID - [Update model](https://docs.getcargo.ai/api-reference/storage--models/update-model.md): Update a model by UUID - [Remove model](https://docs.getcargo.ai/api-reference/storage--models/remove-model.md): Remove a model by UUID - [Get model DDL](https://docs.getcargo.ai/api-reference/storage--models/get-model-ddl.md): Get the DDL for a model's table in the system of record - [Preview model](https://docs.getcargo.ai/api-reference/storage--models/preview-model.md): Preview model data - [Preview model count](https://docs.getcargo.ai/api-reference/storage--models/preview-model-count.md): Get preview count for model data - [Refresh model](https://docs.getcargo.ai/api-reference/storage--models/refresh-model.md): Refresh a model's tables with the latest data - [Get record](https://docs.getcargo.ai/api-reference/storage--records/get-record.md): Get a record for a model by ID - [List records](https://docs.getcargo.ai/api-reference/storage--records/list-records.md): List records for a model - [Create record](https://docs.getcargo.ai/api-reference/storage--records/create-record.md): Insert a single model row. Body: { modelUuid, data } where data is the row fields. - [Create records (bulk)](https://docs.getcargo.ai/api-reference/storage--records/create-records-bulk.md): Insert multiple model rows in one call. Body: { modelUuid, records: [{ data }, ...] }. - [Update record](https://docs.getcargo.ai/api-reference/storage--records/update-record.md): Update a single row. Body: { modelUuid, id, data }; data is merged then id is set under the model id column slug. - [Update records (bulk)](https://docs.getcargo.ai/api-reference/storage--records/update-records-bulk.md): Update multiple rows in one call. Body: { modelUuid, records: [{ id, data }, ...] }. - [Remove record](https://docs.getcargo.ai/api-reference/storage--records/remove-record.md): Remove a single row. Body: { modelUuid, id }. - [Remove records (bulk)](https://docs.getcargo.ai/api-reference/storage--records/remove-records-bulk.md): Remove multiple rows in one call. Body: { modelUuid, ids: [string, ...] }. - [Execute SQL query](https://docs.getcargo.ai/api-reference/storage--query/execute-sql-query.md): Execute a read-only SELECT query against the workspace's storage warehouse. Tables must be referenced as [datasetSlug].[modelSlug] and are rewritten to the underlying warehouse table under the hood. - [Download SQL query results](https://docs.getcargo.ai/api-reference/storage--query/download-sql-query-results.md): Execute a read-only SELECT query against the workspace's storage warehouse and download the results as a file. - [List relationships](https://docs.getcargo.ai/api-reference/storage--relationships/list-relationships.md): List all relationships in the workspace - [Get relationship](https://docs.getcargo.ai/api-reference/storage--relationships/get-relationship.md): Get a relationship by UUID - [Set relationship](https://docs.getcargo.ai/api-reference/storage--relationships/set-relationship.md): Set relationships between models within a connector dataset, or between native object models within the native dataset. Native unify models are not supported. - [List runs](https://docs.getcargo.ai/api-reference/storage--runs/list-runs.md): List model sync runs - [Create run](https://docs.getcargo.ai/api-reference/storage--runs/create-run.md): Create a new model sync run - [Cancel run](https://docs.getcargo.ai/api-reference/storage--runs/cancel-run.md): Cancel a running model sync - [List clients](https://docs.getcargo.ai/api-reference/system-of-record-integration--clients/list-clients.md): List all system of record clients - [Query client](https://docs.getcargo.ai/api-reference/system-of-record-integration--clients/query-client.md): Query data from a system of record client - [Fetch client data](https://docs.getcargo.ai/api-reference/system-of-record-integration--clients/fetch-client-data.md): Fetch data from a system of record client - [Download client data](https://docs.getcargo.ai/api-reference/system-of-record-integration--clients/download-client-data.md): Download data from a system of record client - [Get client documentation](https://docs.getcargo.ai/api-reference/system-of-record-integration--clients/get-client-documentation.md): Get documentation for a system of record client - [List logs](https://docs.getcargo.ai/api-reference/system-of-record-integration--logs/list-logs.md): List system of record integration logs - [Get log metrics](https://docs.getcargo.ai/api-reference/system-of-record-integration--logs/get-log-metrics.md): Get metrics for system of record integration logs - [List systems of record](https://docs.getcargo.ai/api-reference/system-of-record-integration--systems-of-record/list-systems-of-record.md): List all systems of record - [Create system of record](https://docs.getcargo.ai/api-reference/system-of-record-integration--systems-of-record/create-system-of-record.md): Create a new system of record - [Get system of record](https://docs.getcargo.ai/api-reference/system-of-record-integration--systems-of-record/get-system-of-record.md): Get a system of record by UUID - [Update system of record](https://docs.getcargo.ai/api-reference/system-of-record-integration--systems-of-record/update-system-of-record.md): Update a system of record - [Remove system of record](https://docs.getcargo.ai/api-reference/system-of-record-integration--systems-of-record/remove-system-of-record.md): Remove a system of record - [Migrate system of record](https://docs.getcargo.ai/api-reference/system-of-record-integration--systems-of-record/migrate-system-of-record.md): Migrate data to a system of record - [Cutover system of record](https://docs.getcargo.ai/api-reference/system-of-record-integration--systems-of-record/cutover-system-of-record.md): Perform cutover for a system of record - [Get current user](https://docs.getcargo.ai/api-reference/user-management--users/get-current-user.md): Get the current authenticated user - [Update current user](https://docs.getcargo.ai/api-reference/user-management--users/update-current-user.md): Update the current authenticated user - [Fetch file](https://docs.getcargo.ai/api-reference/workspace-management--files/fetch-file.md): Fetch file data - [List file columns](https://docs.getcargo.ai/api-reference/workspace-management--files/list-file-columns.md): List columns from a file - [Upload file](https://docs.getcargo.ai/api-reference/workspace-management--files/upload-file.md): Upload a file to the workspace as multipart/form-data with a 'file' field - [Create multipart upload](https://docs.getcargo.ai/api-reference/workspace-management--files/create-multipart-upload.md): Start a direct-to-S3 multipart upload and return the target key and upload id - [Sign multipart upload part](https://docs.getcargo.ai/api-reference/workspace-management--files/sign-multipart-upload-part.md): Return a presigned URL to upload a single part directly to S3 - [Complete multipart upload](https://docs.getcargo.ai/api-reference/workspace-management--files/complete-multipart-upload.md): Assemble the uploaded parts into the final S3 object - [Abort multipart upload](https://docs.getcargo.ai/api-reference/workspace-management--files/abort-multipart-upload.md): Abort an in-progress multipart upload and discard its parts - [Create folder](https://docs.getcargo.ai/api-reference/workspace-management--folders/create-folder.md): Create a new folder - [List folders](https://docs.getcargo.ai/api-reference/workspace-management--folders/list-folders.md): List all folders - [Get folder](https://docs.getcargo.ai/api-reference/workspace-management--folders/get-folder.md): Get a folder by UUID - [Update folder](https://docs.getcargo.ai/api-reference/workspace-management--folders/update-folder.md): Update a folder - [Remove folder](https://docs.getcargo.ai/api-reference/workspace-management--folders/remove-folder.md): Remove a folder - [List roles](https://docs.getcargo.ai/api-reference/workspace-management--roles/list-roles.md): List all roles - [Get role](https://docs.getcargo.ai/api-reference/workspace-management--roles/get-role.md): Get a role by UUID - [Create report](https://docs.getcargo.ai/api-reference/workspace-management--reports/create-report.md): Submit a user report (feedback) for the current workspace - [Upsert session](https://docs.getcargo.ai/api-reference/workspace-management--sessions/upsert-session.md): Create or update a session - [Create token](https://docs.getcargo.ai/api-reference/workspace-management--tokens/create-token.md): Create a new API token - [List tokens](https://docs.getcargo.ai/api-reference/workspace-management--tokens/list-tokens.md): List all API tokens - [Remove token](https://docs.getcargo.ai/api-reference/workspace-management--tokens/remove-token.md): Remove an API token - [Update token](https://docs.getcargo.ai/api-reference/workspace-management--tokens/update-token.md): Update an API token - [Create user](https://docs.getcargo.ai/api-reference/workspace-management--users/create-user.md): Create a new user in the workspace - [Remove user](https://docs.getcargo.ai/api-reference/workspace-management--users/remove-user.md): Remove a user from the workspace - [List users](https://docs.getcargo.ai/api-reference/workspace-management--users/list-users.md): List all users in the workspace - [Get current user](https://docs.getcargo.ai/api-reference/workspace-management--users/get-current-user.md): Get the current user in the workspace - [Update user](https://docs.getcargo.ai/api-reference/workspace-management--users/update-user.md): Update a user - [Upsert user permissions](https://docs.getcargo.ai/api-reference/workspace-management--users/upsert-user-permissions.md): Grant permissions on a resource to users - [Remove user permission](https://docs.getcargo.ai/api-reference/workspace-management--users/remove-user-permission.md): Remove a permission from a user - [Create workspace](https://docs.getcargo.ai/api-reference/workspace-management--workspaces/create-workspace.md): Create a new workspace - [List workspaces](https://docs.getcargo.ai/api-reference/workspace-management--workspaces/list-workspaces.md): List all workspaces - [Get workspace login providers](https://docs.getcargo.ai/api-reference/workspace-management--workspaces/get-workspace-login-providers.md): Get the login providers for a workspace - [Get current workspace](https://docs.getcargo.ai/api-reference/workspace-management--workspaces/get-current-workspace.md): Get the current workspace - [Update current workspace](https://docs.getcargo.ai/api-reference/workspace-management--workspaces/update-current-workspace.md): Update the current workspace ## OpenAPI Specs - [openapi](https://api.getcargo.io/openapi.json) ## Optional - [Youtube](https://www.youtube.com/@cargohq) - [Community](https://www.getcargo.ai/community) - [Blog](https://www.getcargo.ai/blog)