API ReferenceWorkflows

Create run

Starts a run of a workflow published in Plextera Studio. The run is accepted asynchronously with status PROCESSING; poll Get run or subscribe to workflow events for the result. Workflow-specific input is not validated at this boundary — a wrong input shape 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

Workflow trigger payload. Send application/json for normal JSON input, or multipart/form-data when the workflow needs form-data semantics. Multipart text and JSON parts are forwarded by their original part names. Multipart file parts are uploaded to Plextera File Service and exposed under the same part names as file-node arrays.

Response

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

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

statusenum

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

createdAtdatetime
UTC timestamp when the run was accepted.
updatedAtdatetime
UTC timestamp of the latest known state change.
startedAtdatetime
UTC timestamp when execution started.
completedAtdatetime
UTC timestamp when the run reached a terminal state. Omitted while it is still processing.
errorobject
Failure details. Present only for failed runs.
workflowobject
The workflow this run belongs to.
progressobject
Step completion progress.
durationMslong
Run duration in milliseconds reported by Studio.
computedDurationMslong
Duration in milliseconds computed from start and completion timestamps.
stepslist of objects
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