Get Workflow Run

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


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.

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

Path Parameters#

ParameterTypeRequiredDescription
idIntegerYesThe unique ID of the workflow
runIdIntegerYesThe unique ID of the run

Request#

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

Error Responses#

Run Not Found (404)#

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

{
  "error": "Run not found"
}

Rate Limits#

  • 60 requests per minute per workspace

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