Run an app or workflow

Execute a published app or canvas workflow synchronously — single run or a batch of up to 8 rows.

POST/v1/creative/runs

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

appId?string

Published design app to run. One of appId or workflowId is required.

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

workflowId?string

Canvas workflow to run. One of appId or workflowId is required.

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

inputValues?

Single-run mode: inputs for one execution. Defaults to {}.

rows?array<>

Batch mode: one run per row, max 8 rows per request, executed at concurrency 3. When present, inputValues is ignored.

Items1 <= items <= 8

Response Body

`application/json`

cURL

curl -X POST "https://example.com/creative/runs" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true,
  "run": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "string",
    "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
    "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
    "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
    "nodeResults": {
      "property1": null,
      "property2": null
    },
    "error": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "success": true,
  "run": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "string",
    "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
    "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
    "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
    "nodeResults": {
      "property1": null,
      "property2": null
    },
    "error": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z"
  }
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`