---
title: "Execute action batch"
method: POST
path: "/orchestration/actions/execute-batch"
tags: ["Orchestration - Actions"]
---

# Execute action batch

`POST /orchestration/actions/execute-batch`

Execute an orchestration action as a batch

## Request body

- object — Request body schema.
  - `action` union, required
    - object — Action to execute.
      - `config` object, required
      - `retry` object
        - `maximumAttempts` number
        - `initialInterval` number
        - `backoffCoefficient` number
      - `kind` 'native', required
      - `actionSlug` string, required
    - object — Action to execute.
      - `config` object, required
      - `retry` object
        - `maximumAttempts` number
        - `initialInterval` number
        - `backoffCoefficient` number
      - `kind` 'connector', required
      - `connectorUuid` string
      - `integrationSlug` string, required
      - `actionSlug` string, required
    - object — Action to execute.
      - `config` object, required
      - `retry` object
        - `maximumAttempts` number
        - `initialInterval` number
        - `backoffCoefficient` number
      - `kind` 'tool', required
      - `toolUuid` string
      - `templateSlug` string
      - `releaseUuid` string
      - `waitUntilFinished` boolean
    - object — Action to execute.
      - `config` object, required
      - `retry` object
        - `maximumAttempts` number
        - `initialInterval` number
        - `backoffCoefficient` number
      - `kind` 'agent', required
      - `agentUuid` string
      - `templateSlug` string
      - `releaseUuid` string
      - `waitUntilFinished` boolean
  - `records` object[], required — Records to process.
  - `webhookUrl` string, uri — URL to call when the batch completes.
  - `webhookSecret` string — Secret used to sign webhook deliveries. When provided, Cargo includes an X-Cargo-Signature header (sha256=<hex-hmac>) so you can verify the payload.

## Response `200`

Successful response

- object
  - `batch` object, required — Created batch details.
    - `uuid` string, required
    - `workspaceUuid` string, required
    - `workflowUuid` string, required
    - `userUuid` string, nullable, required
    - `releaseUuid` string, nullable, required
    - `nodes` union[], nullable, required
      - union
        - object
          - `uuid` string, uuid, required
          - `slug` string, required
          - `name` string
          - `config` object, required
          - `description` string
          - `retry` object
            - `maximumAttempts` number
            - `initialInterval` number
            - `backoffCoefficient` number
          - `childrenUuids` string[], required
          - `fallbackChildUuid` string
          - `fallbackOnFailure` boolean, required
          - `position` object, required
            - `x` number, required
            - `y` number, required
          - `kind` 'native', required
          - `actionSlug` string, required
        - object
          - `uuid` string, uuid, required
          - `slug` string, required
          - `name` string
          - `config` object, required
          - `description` string
          - `retry` object
            - `maximumAttempts` number
            - `initialInterval` number
            - `backoffCoefficient` number
          - `childrenUuids` string[], required
          - `fallbackChildUuid` string
          - `fallbackOnFailure` boolean, required
          - `position` object, required
            - `x` number, required
            - `y` number, required
          - `kind` 'connector', required
          - `connectorUuid` string
          - `integrationSlug` string, required
          - `actionSlug` string, required
        - object
          - `uuid` string, uuid, required
          - `slug` string, required
          - `name` string
          - `config` object, required
          - `description` string
          - `retry` object
            - `maximumAttempts` number
            - `initialInterval` number
            - `backoffCoefficient` number
          - `childrenUuids` string[], required
          - `fallbackChildUuid` string
          - `fallbackOnFailure` boolean, required
          - `position` object, required
            - `x` number, required
            - `y` number, required
          - `kind` 'tool', required
          - `toolUuid` string
          - `templateSlug` string
          - `releaseUuid` string
          - `waitUntilFinished` boolean
        - object
          - `uuid` string, uuid, required
          - `slug` string, required
          - `name` string
          - `config` object, required
          - `description` string
          - `retry` object
            - `maximumAttempts` number
            - `initialInterval` number
            - `backoffCoefficient` number
          - `childrenUuids` string[], required
          - `fallbackChildUuid` string
          - `fallbackOnFailure` boolean, required
          - `position` object, required
            - `x` number, required
            - `y` number, required
          - `kind` 'agent', required
          - `agentUuid` string
          - `templateSlug` string
          - `releaseUuid` string
          - `waitUntilFinished` boolean
    - `temporalWorkflowId` string, required
    - `traceUuid` string, nullable, required
    - `data` union, required
      - object
        - `kind` 'segment', required
        - `segmentUuid` string, required
      - object
        - `kind` 'change', required
        - `changeUuid` string, required
        - `changeKinds` string[], required
        - `segmentUuid` string, required
      - object
        - `kind` 'filter', required
        - `modelUuid` string, required
        - `filter` unknown
        - `sort` unknown
        - `limit` number
      - object
        - `kind` 'recordIds', required
        - `modelUuid` string, required
        - `ids` string[], required
      - object
        - `kind` 'watchedRecords', required
        - `modelUuid` string, required
        - `filter` unknown
        - `changeKinds` string[], required
        - `s3Filename` string, required
        - `meta` object
      - object
        - `kind` 'records', required
        - `s3Filename` string, required
      - object
        - `kind` 'file', required
        - `s3Filename` string, required
        - `mappings` object
      - object
        - `kind` 'runs', required
        - `filter` unknown, required
        - `reset` unknown, required
      - object
        - `kind` 'group', required
        - `s3Filename` string, required
        - `parentBatchUuid` string
        - `parentRunUuid` string, required
        - `parentNodeUuid` string, required
      - object
        - `kind` 'schedule', required
        - `modelUuid` string, required
        - `segmentUuid` string, required
        - `changeKinds` string[], required
        - `changeUuid` string
        - `skip` boolean
        - `totalRecordsCount` number
        - `updatedRecordsCount` number
        - `removedRecordsCount` number
        - `addedRecordsCount` number
        - `unchangedRecordsCount` number
      - object
        - `kind` 'form', required
        - `s3Filename` string, required
        - `webhookUrl` string
        - `parentRunUuid` string
        - `parentNodeUuid` string
        - `parentBatchUuid` string
        - `parentAgentUuid` string
        - `parentChatUuid` string
        - `parentMessageUuid` string
    - `errorMessage` string, nullable, required
    - `status` 'pending' | 'syncing' | 'skipped' | 'querying' | 'running' | 'success' | 'error' | 'cancelling' | 'cancelled', required
    - `runsStatus` 'healthy' | 'unhealthy', nullable, required
    - `runsCount` number, required
    - `executedRunsCount` number, required
    - `failedRunsCount` number, required
    - `creditsUsedCount` number, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `finishedAt` string, nullable, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/getcargo/apis/cargo-api.md) · [All operations](https://skmtc.net/getcargo/apis/cargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getcargo/cargo-api/revisions/1d5a19e01d83/schema)