Run Workflow

Overview#

Queue a manual run of a workflow. The run executes asynchronously; the response returns immediately with a runId you can poll via the run detail endpoint.

Each successful run uses one automation credit.

https://api.orshot.com/v1/workflows/:id/run

Path Parameters#

Request#

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

Returns 202 Accepted. Poll GET /v1/workflows/:id/runs/:runId for progress and per-step results.

Error Responses#

Workflow Not Runnable (400)#

{
  "error": "Workflow is not runnable",
  "details": ["no_destination"],
  "hints": ["Add a destination step so every render is delivered somewhere."]
}

Plan Gated Steps (403)#

{
  "error": "Some steps in this workflow require a higher plan",
  "code": "plan_gated"
}

Run Already Queued (409)#

{
  "error": "A run is already queued"
}

Workflow Not Found (404)#

{
  "error": "Not found"
}

Notes#

• The workflow does not need to be active for a manual run; a complete draft runs fine.
• A manual run of a polling workflow reads and advances the poll cursor, exactly like a scheduled run.

Rate Limits#

• 60 requests per minute per workspace