Skip to main content
POST
/
orchestration
/
batches
/
preview
Preview batch
curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/batches/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "segmentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{
  "outcome": "<string>",
  "count": 123,
  "records": [
    {}
  ]
}

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.

​
workflowUuid
string<uuid>
required

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})$
​
data
Data · object
required

Batch input data.

Response

Successful response

​
outcome
string
required

Preview outcome.

Allowed value: "previewed"
​
count
number
required

Total number of records.

​
records
Records · object[]
required

Previewed records.