Get Workflow Run

Get one run's step-by-step detail to see which step failed and why

Published Jul 11, 2026

GET

/v1/workflows/{id}/runs/{runId}

curl -X GET "https://api.orshot.com/v1/workflows/<ID>/runs/<RUN_ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

const res = await fetch("https://api.orshot.com/v1/workflows/<ID>/runs/<RUN_ID>", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

const data = await res.json();

$ch = curl_init("https://api.orshot.com/v1/workflows/<ID>/runs/<RUN_ID>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <ORSHOT_API_KEY>",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://api.orshot.com/v1/workflows/<ID>/runs/<RUN_ID>")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Enterprise Only

The Workflows API is available only to first party clients like the Orshot MCP server and workspaces on the Enterprise plan. Checkout the Enterprise Pricing to get access.

Overview#

Returns one run with its per-step (node) detail: what each step received, what it produced, and the error if it failed. Use this to poll a manual run you queued, or to debug a failing workflow.

Step outputs are summarized (row counts plus a small sample), never full datasets.

Endpoint

https://api.orshot.com/v1/workflows/:id/runs/:runId

Path Parameters#

Parameter	Type	Required	Description
`id`	Integer	Yes	The unique ID of the workflow
`runId`	Integer	Yes	The unique ID of the run

Request#

JavaScript

await fetch("https://api.orshot.com/v1/workflows/44/runs/5121", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

JSON

{
  "run": {
    "id": 5121,
    "status": "success",
    "trigger_type": "manual",
    "rows_total": 3,
    "rows_succeeded": 3,
    "rows_failed": 0,
    "automation_credits_used": 1,
    "render_credits_used": 3,
    "created_at": "2026-07-11T08:00:00.000Z",
    "finished_at": "2026-07-11T08:00:14.879Z"
  },
  "node_runs": [
    {
      "id": 9001,
      "node_index": 0,
      "node_key": "google_drive_new_file",
      "node_type": "trigger",
      "status": "success",
      "rows_in": 0,
      "rows_out": 3,
      "output": { "count": 3, "sample": [{ "json": { "name": "photo-1.jpg" } }] },
      "error": null,
      "started_at": "2026-07-11T08:00:01.301Z",
      "finished_at": "2026-07-11T08:00:03.122Z"
    },
    {
      "id": 9002,
      "node_index": 1,
      "node_key": "render",
      "node_type": "action",
      "status": "success",
      "rows_in": 3,
      "rows_out": 3,
      "output": {
        "count": 3,
        "sample": [
          {
            "json": { "name": "photo-1.jpg" },
            "render": { "url": "https://storage.orshot.com/...jpg" }
          }
        ]
      },
      "error": null,
      "started_at": "2026-07-11T08:00:03.140Z",
      "finished_at": "2026-07-11T08:00:12.660Z"
    }
  ]
}

Error Responses#

Run Not Found (404)#

Returned when the run does not exist or belongs to a different workflow.

JSON

{
  "error": "Run not found"
}

Rate Limits#

60 requests per minute per workspace

Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key

Image, PDF and video generation via API
Visual editor with AI and smart layouts
Zapier, Make, MCP and 50+ integrations
White-label embed for your own app
30 free credits — no credit card required