Flow

Stream execution updates

GET
/flows/{flow}/executions/{execution}/stream

Opens an SSE connection that emits named events:

  • output — one workflow stdout line (a FlowOutput).
  • input — one persisted user response, echoed back so all viewers converge.
  • done — the terminal execution record. Always the last event.

Reconnecting clients pass the standard Last-Event-ID header to resume from the message log; events with seq <= Last-Event-ID are suppressed. EventSource sets this header automatically from the id: field of the last received event.

BearerAuth
headerAuthorizationBearer <JWT>

Admin token, API token issued via /api-tokens, or an OIDC JWT access token issued by the configured OIDC provider.

flow*string
Formatuuid
execution*string
Formatuuid

SSE stream of execution events.

text/event-stream
  1. response

Payload of a output SSE event. Carries one workflow message as a FlowOutput, plus the per-execution sequence number seq.

type*string

Discriminator. Known values: send, wait, stdout.

widget?

Present for send and wait. Opaque widget shape; the workflow runtime owns the schema (see flow/src/api/widget-types.ts).

text?string

Present for stdout. One raw line the workflow printed, verbatim. Protocol messages never appear here.

seq*integer

Per-execution monotonic sequence number.

[key: string]?any
Example Request
curl -X GET 'https://example.com/api/hub/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08/executions/497f6eca-6276-4993-bfeb-53cbbbba6f08/stream'
Example Response
{  "type": "string",  "widget": {},  "text": "string",  "seq": 0}