Create a workflow run

POST

/v1/projects/{projectId}/workflow-runs

curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/workflow-runs' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "revisionRef": "string",
    "mode": "normal",
    "input": {},
    "params": {}
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired

Header parameters

Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

Request body

Content-Typeapplication/json

revisionRefstring
modestring
Allowed values
normal
test
inputobject
paramsobject

Responses

Success

option 1object
- dataobjectrequired
option 2object
- dataobjectrequired

Response example

{
  "data": {
    "steps": [
      {
        "runIndex": 0,
        "stepId": "string",
        "scopeKey": "string",
        "kind": "system",
        "recordingId": "string",
        "dataVersion": "string",
        "algorithmRevisionId": "string",
        "algorithmVersion": "string",
        "cached": false,
        "dependsOn": [
          "string"
        ]
      }
    ],
    "recordings": {
      "included": [
        {
          "recordingId": "string",
          "captureSessionId": "string",
          "sessionRole": "other"
        }
      ],
      "skipped": [
        {
          "recordingId": "string",
          "reason": "string"
        }
      ]
    },
    "estimate": {
      "cpuSeconds": 0,
      "gpuSeconds": 0,
      "storageBytes": 0,
      "durationSeconds": 0,
      "costMinor": 0,
      "currency": "usd"
    },
    "cachedSteps": 0,
    "workflowRevisionId": "string",
    "planToken": "string",
    "runGroupId": {},
    "runs": {}
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1