BAbannerbear

Run a workflow

Changed on

Start a workflow. Async — returns 202 immediately; poll GET /workflow_runs/{uid} until status is completed or failed. Steps run in order, each feeding the next. A run charges nothing itself: each step is billed as the resource it creates, so a run costs exactly what running its steps individually would. To process many rows, POST once per row — each is its own run.

post/workflow_runs

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Request body

workflowstring required

Workflow UID

inputsobject

Values for the workflow's declared inputs. May also be sent as a bare top-level object instead of nested under inputs.

metadatastring

Arbitrary metadata string stored with the run

Response

Run queued

uidstring
status'queued' | 'running' | 'completed' | 'failed'
workflowstring

UID of the workflow that was run

progressinteger

Percentage of steps completed. A failed run reports how far it got.

inputsobject

Inputs this run was started with

outputsobject

Every completed step's output, keyed by step name

metadatastring nullable

Arbitrary metadata string round-tripped from the create request

errorstring

Only present when the run failed

selfstring uri
created_atstring date-time
completed_atstring date-time nullable

Changes