Workflow Execution Steps API
Description: Retrieves details about each step executed in a specific workflow run. A step is defined as a node within the workflow. A run is a single execution of a workflow.
Request Syntax:
GET workflows/{workflow_id}/runs/{run_id}/steps
Authentication: Bearer <Your API key>
Response Syntax:
[
{
"id": "",
"user_id": "",
"organization_id": "",
"node_id": "",
"status": "",
"start_time": "",
"end_time": "",
"elapsed_time": int,
"error": "",
"outputs": { ... },
"inputs": { ... },
"step_metadata": null,
"tokens": 0
},
{ ... }
]
Response Syntax Variables
For each node in the workflow, there will be the following output:
id: ID associated with the specific step in the workflow
User id: ID associated with the user who executed the workflow
Organization id: ID of the organization where the workflow is stored
Node id: ID for the specific node which is executed during this step
Status: status of the workflow step
Start time: date-time when the step began execution
End time: date-time when the step finished execution
Elapsed time: Amount of seconds the step took to complete
Error: Any errors which occurred during step execution
Outputs: The output of the step
Output data will vary based on the specific node which is executed
Inputs: The input to the step
Input data will vary based on the specific node which is executed
Step Metadata: Metadata associated with the specific step
Tokens: number of tokens utilized in the step
Currently this is always set to 0
Last updated