Docs
Sign in

Follow the timeline live (server-sent events).

Each message has id: <seq>, event: event and the timeline event as JSON in data.

GET/api/v1/events/stream

Scoperead

Takes the same filters as GET /events. Reconnect with the Last-Event-ID header (or after=<seq>) to replay everything missed, in order, before going live; without either the stream starts at now. A comment line every 15 seconds keeps the connection open. A key may hold 8 streams at once. No path parameters.

Query parameters.

crewIdstring

Only those of this crew. At least 5 characters.

taskIdstring

Only those of this task. At least 5 characters.

agentIdstring

Only those of this agent. At least 5 characters.

runIdstring

Only those of this run. At least 5 characters.

nodeIdstring

Only those of this machine. At least 5 characters.

vmIdstring

Only those of this VM. At least 5 characters.

kindarray

One or more values, comma-separated. For events: exact kinds or prefixes such as run.*. 1 to 30 items.

levelarray

One or more levels, comma-separated. Any of info, warn, error. At least 1 item.

afterinteger

Only events with a seq greater than this. ≥ 0.

signalsboolean

Experimental, for the dashboard: also send changed messages naming a record to refetch. Default false.

Headers.

Last-Event-IDstring

The seq of the last event received; everything after it is replayed.

Response.

Server-sent events. Each data line is an Event as JSON; reconnect with Last-Event-ID to be sent what you missed.