API ReferencePlatform API

Api Workflow Runs Create

Execute a workflow manually. Returns the completed result or a paused run id for workflows with async (human) steps.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Request

This endpoint expects an object.
workflow_idstringRequired>=1 character

Workflow ID (or versioned ID ‘workflow_id:version’) to execute.

payloadmap from strings to anyOptional
event_typestring or nullOptional

Response

statusstring
'completed' or 'paused'.
resultsany

Final output(s) on sync completion.

workflow_run_idstring

Run id to resume later (paused runs only).

paused_at_stepstring or null
Label of the step that paused the run.