API Reference

Run a workflow now

Start a workflow's next run within about a minute, without changing its schedule.

Requires the workflows:write scope.

Response. 202 { "run": { id, status: "queued", startedAt }, "deduplicated": false }. The run starts within about a minute and then shows in GET /workflows/{id}/runs under the same id, moving from queued to running and then done or failed.

deduplicated: true means no new run was queued: the clientRequestId was seen before, or the workflow already has a run queued or running, and run is that one.

CodeMeaning
409error is paused (resume it first), schedule_pending (the schedule is still being set up, so retry shortly) or schedule_error (fix scheduleText).
post/api/v1/workflows/{id}/runs

Request

  • Base URL: https://revnu.com
  • URL: https://revnu.com/api/v1/workflows/{id}/runs
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

object required

Response

202 { "run": { id, status: "queued", startedAt }, "deduplicated": false }. The run starts within about a minute and then shows in GET /workflows/{id}/runs under the same id, moving from queued to running and then done or failed. deduplicated: true means no new run was queued: the clientRequestId was

deduplicatedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.