Stream Events

Opens a Server-Sent Events (SSE) stream for real-time events from a replica. The connection remains open and events are pushed as they occur.

Each event is delivered as an SSE message in the format data: <JSON>\n\n. A heartbeat ping is sent every 15 seconds to keep the connection alive. Clients should reconnect automatically on disconnect.

All events share a common envelope structure with id (unique event ID), ts (ISO 8601 timestamp), type (event type discriminator), and payload (type-specific data). See the EngineEvent schema for all possible event types.

GET /v1/replica/{id}/events

Stream Events

cURL

curl --request GET \
  --url https://api.tryreplicas.com/v1/replica/{id}/events \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "ts": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "payload": {
    "version": "v1"
  }
}

Authorizations

Authorization · string · header · required

API key authentication. Obtain your API key from the Replicas dashboard under Settings > API Keys.

Path Parameters

id · string<uuid> · required

The unique identifier of the replica

Response

200

text/event-stream

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

engine.ready

engine.status.changed

repo.discovered

repo.status.changed

chat.created

chat.updated

chat.deleted

chat.turn.accepted

chat.turn.started

chat.turn.delta

chat.turn.completed

chat.interrupted

hooks.started

hooks.progress

hooks.completed

hooks.failed

hooks.status

preview.changed

error

Engine initialization complete.

id · string · required

Unique event ID

ts · string<date-time> · required

ISO 8601 timestamp

type · string · required

Allowed value: "engine.ready"

payload · object · required

Show child attributes