Stream best-effort live execution events for a workflow instance.
Stream best-effort live execution events for a workflow instance. - Rensei REST API operation reference.
AuthorizationBearer <rsk_live_*>Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.
id*string1 <= lengthinstanceId*string1 <= lengthLive-only SSE. heartbeat data is {timestamp}; complete data is {status} where status is completed, failed, cancelled, or waiting; step_state data is the executor event object. Redis step events are best-effort and may be missed before connection or across reconnects. Live step and heartbeat frames may also be dropped when bounded Redis or HTTP backpressure buffers fill; terminal complete is prioritized and reconciled from durable instance state. No replay, Last-Event-ID, or total ordering is promised.
response?stringtext/event-streamSSE-framed text. Event names are heartbeat, step_state, and complete.
curl -X GET 'https://app.rensei.ai/api/workflows/string/instances/string/stream'"string"Stream ledger lifecycle events for one admitted session.
Server-sent events. Each UNNAMED (default `message`) frame is one SessionEventEnvelope carrying its channel discriminator and native cursor. Two named control events are interleaved: `heartbeat` ({timestamp}) every 15s so an idle stream is provably alive, and `reconnect` ({reason, timestamp}) immediately before the stream self-closes at its lifetime bound - resume from the last envelope cursor. A close without a `reconnect` event means the session reached a terminal phase and its events are drained. Closing the connection is a delivery boundary only: it never changes session identity or terminal state.
Bind an app installation to the authenticated human.
Create or reconcile an exact bootstrap retry. Persist the installation identifier, operation identifier and CSPRNG-generated 32-byte proof securely before sending. The receipt grants no session access or push registration.