VEverbiflow
plays

Append Workflow Progress Event

post/api/workflow-runs/{run_id}/progress

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/workflow-runs/{run_id}/progress
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Path parameters

run_idstring required

Request body

child_operation_idstring nullable

Distinct child operation id for workflow-step progress only.

completedinteger nullable

Completed work units.

detailstring nullable

Optional bounded human-facing progress detail.

event_idstring required

Stable idempotency identity for this exact progress event.

labelstring required

Short human-facing operation label.

status'queued' | 'running' | 'blocked' | 'completed' | 'failed' | 'cancelled' required

Canonical operation lifecycle state.

terminalboolean

True exactly for completed, failed, or cancelled status.

totalinteger nullable

Total work units; valid only with completed.

Response

Successful Response

Changes

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