For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Real-time streaming of user speech (STT) and agent speech (TTS) events for an active call via Server-Sent Events.
The connection is real-time — events stream directly from the call runtime as they are produced. The SSE connection auto-closes when the call ends (`sse_close` event). Only active calls can be subscribed to; completed calls return a 400 error.
**Transcript event types:**
- `user_interim_transcription` — Partial, in-progress transcription as the user speaks. Use for live preview only; will be superseded by `user_transcription`.
- `user_transcription` — Final transcription for a completed user speech turn.
- `tts_completed` — Fired when the agent finishes speaking a TTS segment. Includes the spoken text and optionally TTS latency.
**Lifecycle events:**
- `sse_init` — Sent immediately when the SSE connection is established.
- `sse_close` — Sent when the call ends, right before the server closes the connection.
Other event types (e.g. `call_start`, `call_end`, `turn_latency`, metrics) are also sent on this stream.
Authentication
AuthorizationBearer
API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.
Query parameters
callIdstringRequired
The call ID to subscribe events for
Response
SSE event stream established successfully
event_typeenum
The type of event
Allowed values:
event_idstring
Unique identifier for the event
timestampdatetime
ISO 8601 timestamp of the event
call_idstring
The call ID this event belongs to
interim_transcription_textstring
Partial transcription text (only for user_interim_transcription)
user_transcription_textstring
Final transcription text (only for user_transcription)
tts_textstring
Text spoken by the agent (only for tts_completed)
tts_latencyinteger
TTS latency in milliseconds (only for tts_completed)
Errors
400
Bad Request Error
404
Not Found Error
Real-time streaming of user speech (STT) and agent speech (TTS) events for an active call via Server-Sent Events.
The connection is real-time — events stream directly from the call runtime as they are produced. The SSE connection auto-closes when the call ends (sse_close event). Only active calls can be subscribed to; completed calls return a 400 error.
Transcript event types:
user_interim_transcription — Partial, in-progress transcription as the user speaks. Use for live preview only; will be superseded by user_transcription.
user_transcription — Final transcription for a completed user speech turn.
tts_completed — Fired when the agent finishes speaking a TTS segment. Includes the spoken text and optionally TTS latency.
Lifecycle events:
sse_init — Sent immediately when the SSE connection is established.
sse_close — Sent when the call ends, right before the server closes the connection.
Other event types (e.g. call_start, call_end, turn_latency, metrics) are also sent on this stream.