Workflows

Run workflow

Run a specific workflow by its ID.

post/orgs/workflows/{workflow_id}/runs

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/workflows/{workflow_id}/runs
  • Auth: HTTP bearer

Path parameters

workflow_idstring required

The ID of the workflow

Query parameters

expandboolean

Request body

inputobject

Values of the fields

streamboolean

Indicates if the run should stream output to the client as it becomes available via SSE (Server-Sent Events)

backgroundboolean

Indicates if the run should be executed in the background and return the run information immediately

from_step_keystring

Step key to start the run from

identifierstring

Temporary WebSocket identifier used to track run status before creation completes

Response

idstring required

Unique identifier for the run

resultunknown
outputsRunOutputsSchema

Outputs of all steps in the run

status'PENDING' | 'RUNNING' | 'CANCELED' | 'COMPLETED' | 'SKIPPED' | 'FAILED' required

Status of the run

origin'WORKFLOW' | 'TRIGGER' | 'WEBHOOK' required

Origin of the run

errorstring

Error message if the run failed

started_atstring date-time nullable required

Timestamp of when the run started

ended_atstring date-time nullable required

Timestamp of when the run ended

org_idstring required

ID of the associated org where the run was triggered from

workflow_org_idstring required

ID of the associated org where the workflow belongs to

workflow_idstring required

ID of the associated workflow

versionnumber

Version number of the workflow

usageCreditsRunUsageSchema (unresolved $ref)
created_atstring date-time nullable required

Timestamp of when the run was created

updated_atstring date-time nullable required

Timestamp of when the run was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.