API ReferenceWorkflows

Create run

Starts a published workflow asynchronously. - The initial status is `PROCESSING`. - Poll **Get run** or subscribe to workflow events for the result. - Invalid workflow-specific input surfaces later as a failed run.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Path parameters

workflowIdstringRequired
Identifier of the published workflow to run.

Request

Choose the body format expected by the workflow: - `application/json` sends normal JSON input. - `multipart/form-data` preserves text and JSON part names. - Multipart files are uploaded to File Service and exposed as file-node arrays.

Response

Run accepted and processing. Poll or subscribe for the result.
idstringOptional

Run identifier. Use it with GET /workflow-runs/{runId} and event correlation.

statusenumOptional

Current run state. Stop polling on COMPLETED, FAILED, or CLOSED.

createdAtdatetimeOptional
UTC timestamp when the run was accepted.
updatedAtdatetimeOptional
UTC timestamp of the latest known state change.
startedAtdatetimeOptional
UTC timestamp when execution started.
completedAtdatetimeOptional
UTC timestamp when the run reached a terminal state. Omitted while it is still processing.
errorobjectOptional
Failure details. Present only for failed runs.
workflowobjectOptional
The workflow this run belongs to.
progressobjectOptional
Step completion progress.
durationMslongOptional

Wall-clock duration from createdAt to completedAt in milliseconds. Omitted until the run is terminal.

computedDurationMslongOptional
Active processing time in milliseconds reported by Studio, excluding wait states and idle time in parallel branches. May be omitted from list summaries.
stepslist of objectsOptional
Executed steps with their public output.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error