Get Live

Events

Stream realtime events

get/v1/events

Opens a Server-Sent Events stream. The first event is always a status snapshot. Subsequent events are sent whenever voice changer status, selected voice, quality mode, monitoring, or the sounds playing change.

Event names and payloads:

  • status: the voice changer status, including latencyMs; sent when the state changes or the latency moves by 20 ms or more. The initial snapshot also includes selected voice, quality mode, and monitoring state
  • voice: { "voiceId": "hazel" }
  • quality: { "mode": "adaptive" }
  • monitoring: { "enabled": true }
  • sounds: { "playing": ["pad_3f2a"] }, the pad IDs playing now, whoever pressed them (an empty list when the last one ends)

A keepalive comment is sent every 15 seconds while no events occur, and SSE clients are instructed to reconnect after two seconds if disconnected. Browser clients should use streaming fetch so the Bearer authorization header can be included; native EventSource cannot set that header.

Responses

200Realtime Server-Sent Events stream
401Invalid or missing API key
  • errorstringRequired

    Error message