Skip to main content
POST
/
orchestration
/
plays
Create play
curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/plays \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "changeKinds": [],
  "description": "<string>",
  "sort": [
    {
      "columnSlug": "<string>"
    }
  ],
  "limit": 123,
  "trackingColumnSlugs": [
    "<string>"
  ],
  "schedule": {
    "type": "<string>",
    "jobId": "<string>"
  },
  "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "play": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "workflowUuid": "<string>",
    "userUuid": "<string>",
    "modelUuid": "<string>",
    "segmentUuid": "<string>",
    "changeKinds": [
      "<string>"
    ],
    "name": "<string>",
    "description": "<string>",
    "schedule": {
      "type": "<string>",
      "temporalScheduleWorkflowId": "<string>",
      "meta": {}
    },
    "isEnabled": true,
    "healthThreshold": 123,
    "healthAlertActions": [
      {
        "actionSlug": "<string>",
        "connectorUuid": "<string>",
        "config": {}
      }
    ],
    "folderUuid": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<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.

​
name
string
required

Play name.

​
modelUuid
string<uuid>
required

Model 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})$
​
changeKinds
enum<string>[]
required

Change kinds to include.

Available options:
added,
updated,
removed,
unchanged
​
runCreationRule
enum<string>
required

Run creation rule.

Available options:
always,
once,
noConcurrency
​
description
string

Play description.

​
filter
Filter · object

Segment filter criteria.

​
sort
Sort · object[]

Sort criteria.

​
limit
number

Maximum number of records.

​
trackingColumnSlugs
string[]

Tracking column identifiers.

​
schedule
Schedule · object

Play schedule configuration.

​
folderUuid
string<uuid>

Folder 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})$

Response

Successful response

​
play
Play · object
required

Created play details.