Skip to main content
GET
Stream events

Authorizations

Authorization
string
header
required

Organization or personal API key from Settings → API Keys.

Headers

Last-Event-ID
string

The SSE id of the last event received. When the engine still holds every event after it, they are replayed and engine.stream.opened reports resumed: true; otherwise it reports resumed: false and only live events follow.

Example:

"0b6f4c1e-8d2a-4f3e-9c1b-2a7d5e6f8a90:1042"

X-Replicas-Api-Version
enum<string>

API version. 2026-10-07 returns snake_case responses. See versioning.

Available options:
2026-10-07

Path Parameters

id
string<uuid>
required

The unique identifier of the replica

Response

SSE event stream opened successfully. Each line is a JSON-encoded EngineEvent.

The first event on every stream. resumed is true when the events after the request's Last-Event-ID follow, and false when some may have been missed: a new engine boot, a gap older than the engine keeps, or no Last-Event-ID.

id
string
required
ts
string<date-time>
required
type
string
required
Allowed value: "engine.stream.opened"
payload
object
required