Skip to main content
POST
Create play

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

name
string
required

Play name.

Required string length: 1 - 255
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.

Required string length: 1 - 1000
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

Create play

play
Play · object
required

Created play details.