Skip to main content
WSS
bearerAuth
type:http

Telnyx API v2 Bearer token authentication.

query
type:object

Query parameters passed when opening the WebSocket connection.

Audio Frame
type:string

Client-to-server binary frame containing audio data to transcribe. Audio should be in mp3 or wav format as specified in the input_format query parameter.

Transcript Frame
type:object

Server-to-client frame containing a transcription result. When interim_results is enabled, you may receive multiple interim results (is_final=false) before the final result (is_final=true) for each utterance.

Reson8 transcribes per turn of speech: each interim frame carries the full transcript of the turn so far and supersedes the previous frame, the final frame arrives when the turn ends, and confidence is omitted from its frames.

Error Frame
type:object

Server-to-client frame indicating an error during transcription. The connection may be closed shortly after sending this frame.