Get a Workflow Run

Get a specific workflow run details

The Workflow Runs API allows you to get the details of a run.

Headers

string required

Your unique API key for authentication.

This key is required in the header of all API requests, to authenticate your account and access Draft & Goal’s services. Get your API key from the Draft & Goal Dashboard.

Path Parameters

run_id string required

The ID of the workflow run you want to get.

Query Parameters

all_completed_steps boolean default: false

Whether to include all completed steps in the response.

Default is false.

During the workflow run

If the workflow run is still running, you will receive a 250 HTTP status code. Please wait a few minutes and poll the endpoint again.

Response

success boolean required

Whether the workflow run was successful.

data object required

The data returned by the workflow run.

Data Structure

run_id string required

The workflow run ID.

workflow_id string required

The ID of the workflow that was run.

inputs object required

The inputs of the workflow run.

Each key in this object represents an input node ID from your workflow.

Input Parameters Structure

inputs.*.value string required

The value of the input parameter.

inputs.*.type string required

The type of the input value. Possible values: “text”

state string required

The state of the workflow run.

Available options: DONE, FAILED, USER_ABORTED

error string

The error that occurred during the workflow run.

started_at string

The date and time the workflow run was started.

ended_at string

The date and time the workflow run was ended.

completed_steps object[] required

The steps that were completed during the workflow run.

Tip

You can use the node ID of a step to select a specific step to get the output.

Completed Step Structure

stepId string required

The ID of the step.

nodeId string required

The ID of the node.

state string required

The state of the step.

Available option: DONE

downloadable_output boolean required

Whether the step has a downloadable output.

output string | null required

The output of the step if the step has a downloadable output.

started_at string | null required

The date and time the step was started.

ended_at string | null required

The date and time the step was ended.

failed_steps object[] required

The steps that failed or were aborted during the workflow run.

Failed Step Structure

step_id string required

The ID of the step.

node_id string required

The ID of the node. You can use this ID to select a specific node to retrieve the output.

state string required

The state of the step.

Available options: FAILED, USER_ABORTED

error string required

The error that occurred during the step.

started_at string | null required

The date and time the step was started.

ended_at string | null required

The date and time the step was ended.

Response Example

{
  "success": true,
  "data": {
    "run_id": "0cf35172-859e-4b26-8ce9-6c2588a77b40",
    "workflow_id": "ab44401b-6947-46bc-8248-47aa2dacf856",
    "inputs": {
      "Text_0": {
        "value": "Hello world",
        "type": "text"
      }
    },
    "state": "DONE",
    "error": null,
    "started_at": "2025-02-17T13:33:45.575000",
    "ended_at": "2025-02-17T13:36:17.194000",
    "completed_steps": [
      {
        "step_id": "ee7d2258-8ff5-4176-8498-110f8dc8d264",
        "node_id": "LLM_0",
        "state": "DONE",
        "downloadable_output": true,
        "output": "Example output",
        "started_at": "2025-02-17T13:33:45.575000",
        "ended_at": "2025-02-17T13:34:17.194000"
      },
      {
        "step_id": "d5c913ab-0970-49f3-955a-eee4b2447276",
        "node_id": "LLM_1",
        "state": "DONE",
        "downloadable_output": false,
        "output":null,
        "started_at": "2025-02-17T13:35:45.575000",
        "ended_at": "2025-02-17T13:36:17.194000"
      }
    ],
    "failed_steps": []
  }
}

{
  "message": "Workflow Run generation on the way. Please wait a few minutes."
}

{
  "type": "error",
  "error": {
    "message": "You don't have access to this workflow run"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid workflowrun id | Run deleted"
  }
}

Request Example

curl "https://agents-api.prod.dng.ai/api/v1/workflow-runs/$WORKFLOW_RUN_ID" \
          --header "x-api-key: $YOUR_API_KEY" \
          --header "content-Type: application/json"