Workflow Execution API

Description: Initiates execution of the specified workflow.

Try it out: Swagger Reference

Request Syntax:

POST /workflows/{workflow_id}/execute
Authentication: Bearer <Your API key>
Content-type: application/json

{
  "input_variable_1": "",
  "input_variable_2": ""
}

You can get the {workflow_id} from the workflow page.

Response Syntax:

{
    "message": "",
    "run_id": ""
}

Execute a Workflow Response Example

{
    "message": "Workflow execution started",
    "run_id": "fda37c90-dd1c-4317-82d1-797b7f77fca5"
}

Response Syntax Variables

• Message: Indication that the workflow execution has begun

• Run id: ID for this specific execution of the workflow