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 '
{
  "workflowUuid": "<string>",
  "data": {
    "kind": "segment",
    "segmentUuid": "<string>"
  }
}
'
{
  "batch": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "workflowUuid": "<string>",
    "releaseUuid": "<string>",
    "nodes": [
      {
        "uuid": "<string>",
        "slug": "<string>",
        "config": {},
        "childrenUuids": [
          "<string>"
        ],
        "fallbackOnFailure": true,
        "position": {
          "x": 123,
          "y": 123
        },
        "kind": "native",
        "actionSlug": "<string>",
        "name": "<string>",
        "description": "<string>",
        "retry": {
          "maximumAttempts": 123,
          "initialInterval": 123,
          "backoffCoefficient": 123
        },
        "fallbackChildUuid": "<string>"
      }
    ],
    "temporalWorkflowId": "<string>",
    "data": {
      "kind": "<string>",
      "segmentUuid": "<string>"
    },
    "errorMessage": "<string>",
    "status": "pending",
    "runsStatus": "healthy",
    "runsCount": 123,
    "executedRunsCount": 123,
    "failedRunsCount": 123,
    "creditsUsedCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "finishedAt": "<string>"
  }
}

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.

workflowUuid
string
required

Workflow identifier.

data
Data · object
required

Batch input data.

Response

Successful response

batch
Batch · object
required

Created batch details.