Get a workflow run

Changed on
get/workflow_runs/{uid}

Request

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

Path parameters

uidstring required

Response

Run details, live progress, and per-step results

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