---
title: "Create batch"
method: POST
path: "/orchestration/batches"
tags: ["Orchestration - Batches"]
---

# Create batch

`POST /orchestration/batches`

Create a new orchestration batch

## Request body

- object — Request body schema.
  - `workflowUuid` string, uuid — Workflow identifier.
  - `releaseUuid` string, uuid — Release identifier to run.
  - `nodes` union[] — Custom nodes to use for the batch.
    - 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
  - `data` union, required — Batch input data.
    - object
      - `kind` 'segment', required — Data kind.
      - `segmentUuid` string, uuid, required — Segment identifier.
    - object
      - `kind` 'change', required — Data kind.
      - `changeUuid` string, uuid, required — Change identifier.
      - `changeKinds` string[], required — Change kinds to include.
    - object
      - `kind` 'filter', required — Data kind.
      - `modelUuid` string, uuid, required — Model identifier.
      - `filter` object — Filter criteria.
        - `conjonction` 'or' | 'and', required
        - `groups` object[], required
          - `conjonction` 'or' | 'and', required
          - `conditions` union[], required
            - union
              - …
      - `sort` object[] — Sort criteria.
        - `columnSlug` string, required
        - `kind` 'asc' | 'desc', required
      - `limit` number — Maximum number of records.
    - object
      - `kind` 'file', required — Data kind.
      - `s3Filename` string, required — S3 file identifier.
      - `mappings` object — Field mappings for file data.
    - object
      - `kind` 'runs', required — Data kind.
      - `filter` union, required
        - object — Runs filter criteria.
          - `batchUuid` string, uuid — Batch identifier to filter by.
          - `releaseUuid` string, uuid — Release identifier to filter by.
          - `parentBatchUuid` string, uuid — Parent batch identifier.
          - `parentRunUuid` string, uuid — Parent run identifier.
          - `parentNodeUuid` string, uuid — Parent node identifier.
          - `isGroupParent` boolean — Whether the run is a group parent.
          - `executionsFilter` object — Executions filter criteria.
            - `conjonction` 'or' | 'and', required
            - `groups` object[], required
              - …
          - `createdAfter` string — Include runs created after this timestamp.
          - `createdBefore` string — Include runs created before this timestamp.
          - `kind` 'runs', required — Filter kind.
          - `uuids` string[] — Run identifiers to include.
          - `recordTitle` string — Record title to filter by.
          - `statuses` string[] — Run statuses to include.
        - object — Runs filter criteria.
          - `batchUuid` string, uuid — Batch identifier to filter by.
          - `releaseUuid` string, uuid — Release identifier to filter by.
          - `parentBatchUuid` string, uuid — Parent batch identifier.
          - `parentRunUuid` string, uuid — Parent run identifier.
          - `parentNodeUuid` string, uuid — Parent node identifier.
          - `isGroupParent` boolean — Whether the run is a group parent.
          - `executionsFilter` object — Executions filter criteria.
            - `conjonction` 'or' | 'and', required
            - `groups` object[], required
              - …
          - `createdAfter` string — Include runs created after this timestamp.
          - `createdBefore` string — Include runs created before this timestamp.
          - `kind` 'records', required — Filter kind.
          - `ids` string[] — Record identifiers to include.
          - `title` string — Record title to filter by.
          - `statuses` string[] — Record statuses to include.
      - `reset` union, required — Reset options.
        - object
          - `from` 'lastNode', required — Reset from the last node.
        - object
          - `from` 'firstNode', required — Reset from the first node.
        - object
          - `from` 'nextNode', required — Reset from the next node.
        - object
          - `from` 'node', required — Reset from a specific node.
          - `nodeUuid` string, uuid, required — Node identifier to reset from.
    - object
      - `kind` 'recordIds', required — Data kind.
      - `modelUuid` string, uuid, required — Model identifier.
      - `ids` string[], required — Record identifiers.
    - object
      - `kind` 'records', required — Data kind.
      - `records` object[], required — Inline records.
    - object
      - `kind` 'schedule', required — Data kind.
      - `modelUuid` string, uuid, required — Model identifier.
      - `segmentUuid` string, uuid, required — Segment identifier.
      - `changeKinds` string[], required — Change kinds to include.
      - `skip` boolean — Whether to skip scheduling.
    - object
      - `kind` 'form', required — Data kind.
      - `records` object[], required — Form records.
      - `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.
      - `parentRunUuid` string, uuid — Parent run identifier.
      - `parentNodeUuid` string, uuid — Parent node identifier.

## 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)