Skip to main content
POST
/
orchestration
/
batches
Create batch
curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "segmentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nodes": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "config": {},
      "childrenUuids": [
        "<string>"
      ],
      "fallbackOnFailure": true,
      "position": {
        "x": 123,
        "y": 123
      },
      "actionSlug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "retry": {
        "maximumAttempts": 123,
        "initialInterval": 123,
        "backoffCoefficient": 123
      },
      "fallbackChildUuid": "<string>"
    }
  ]
}
'
{
  "batch": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "workflowUuid": "<string>",
    "userUuid": "<string>",
    "releaseUuid": "<string>",
    "nodes": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "config": {},
        "childrenUuids": [
          "<string>"
        ],
        "fallbackOnFailure": true,
        "position": {
          "x": 123,
          "y": 123
        },
        "actionSlug": "<string>",
        "name": "<string>",
        "description": "<string>",
        "retry": {
          "maximumAttempts": 123,
          "initialInterval": 123,
          "backoffCoefficient": 123
        },
        "fallbackChildUuid": "<string>"
      }
    ],
    "temporalWorkflowId": "<string>",
    "traceUuid": "<string>",
    "data": {
      "kind": "<string>",
      "segmentUuid": "<string>"
    },
    "errorMessage": "<string>",
    "runsCount": 123,
    "executedRunsCount": 123,
    "failedRunsCount": 123,
    "creditsUsedCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "finishedAt": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

​
data
Data · object
required

Batch input data.

​
workflowUuid
string<uuid>

Workflow identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
​
releaseUuid
string<uuid>

Release identifier to run.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
​
nodes
Nodes · object[]

Custom nodes to use for the batch.

Response

Successful response

​
batch
Batch · object
required

Created batch details.