Skip to main content
GET
Stream Workflow Events

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

workflow_run_id
string<uuid>
required

Workflow run ID whose event stream to resume, from the response or streaming events of Run Workflow.

Query Parameters

user
string
required

End-user identifier, defined by your app and unique within it. Must match the user that started the run. See End User Identity.

include_state_snapshot
boolean
default:false

Set to true to get back a form whose human_input_required event you missed. Without it, the stream carries only events published after you connect.

With it, the stream replays the run so far before any new events:

  • Each executed node's status
  • For a paused run, a human_input_required for each form still waiting, then workflow_paused

The replayed human_input_required events carry the same fields as the live ones, including the same form_token.

continue_on_pause
boolean
default:false

Set to true to keep the stream open across multiple workflow_paused events (useful when the workflow has more than one Human Input node in sequence). Default closes the stream after the first pause.

Response

Server-Sent Events stream. It opens with a bare event: ping frame (keep-alive; more arrive roughly every 10 seconds); every other event is delivered as data: {JSON}\n\n. Event payloads follow the same schemas as the original streaming response.

SSE stream of events from a resumed workflow run, in the same format as Run Workflow (Workflow apps) or Send Chat Message (Chatflow apps). When the resumed portion runs an LLM node with reasoning_format: separated, this stream also carries reasoning_chunk events.