Skip to main content
POST
/
workflows
/
v1
/
workflow-runs
Start Or Resume Workflow
curl --request POST \
  --url https://api-qa.interactly.ai/workflows/v1/workflow-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dynamic_variables": {},
  "runtime_variables": {},
  "miscellaneous": {},
  "command": "start",
  "workflow_id": "5eb7cf5a86d9755df3a6c593",
  "workflow_run_id": "5eb7cf5a86d9755df3a6c593",
  "thread_to_node_inputs": {}
}
'
{
  "workflow_run": {
    "team_id": "<string>",
    "created_by": "<string>",
    "updated_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "workflow_run": {
      "logical_id": "<string>",
      "workflow_id": "<string>",
      "status": "not_started",
      "input_output_pairs": [
        {
          "run_input": {
            "dynamic_variables": {},
            "runtime_variables": {},
            "miscellaneous": {},
            "command": "start",
            "workflow_id": "<string>",
            "workflow_run_id": "<string>",
            "thread_to_node_inputs": {}
          },
          "run_output": {
            "events": [
              "<unknown>"
            ],
            "thread_to_node_outputs": {}
          }
        }
      ],
      "comments": [
        {
          "logical_id": "<string>",
          "content": "<string>",
          "createdBy": "5eb7cf5a86d9755df3a6c593",
          "updatedBy": "5eb7cf5a86d9755df3a6c593",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json

Input to the workflow, used to kick off or resume a workflow run.

​
dynamic_variables
Dynamic Variables · object

Dynamic variable values that will replace the '{{...}}' placeholders in the prompts, condition strings, tool signatures, etc.

​
runtime_variables
Runtime Variables · object

Runtime variables that will replace the '[[...]]' placeholders in the prompts, condition strings, tool signatures, etc.

​
miscellaneous
Miscellaneous Run Input Data · object

Miscellaneous run-input data

​
command
enum<string>
default:start

Command to execute on the workflow or workflow run

Available options:
start,
data,
resume,
pause,
stop
​
workflow_id
string | null

ID of the workflow to run

Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

​
workflow_run_id
string | null

ID of the workflow run to resume

Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

​
thread_to_node_inputs
Thread to Node Inputs · object

Mapping of thread IDs to node inputs

Response

Successful Response

Response model for a single workflow run. Contains a WorkflowRunsModel object.

​
workflow_run
WorkflowRunsModel · object
required

Single workflow run object