Speech-to-Text WebSocket parameters

All parameters are passed as query string values on the WebSocket URL. Locked at connection time — cannot be changed mid-session.

string

default:"Deepgram"

Deepgram, Telnyx, Google, Azure, xAI, AssemblyAI, Speechmatics, Soniox, Parakeet

string

default:"per engine"

string

default:"mp3"

integer

default:"16000"

Hz. Required for raw encodings (linear16, mulaw, alaw). Ignored for container formats. Invalid value returns error 40005.

string

default:"en-US"

Language code or auto-detect behavior varies by engine. See Language for details.

string

default:"false"

"true" for partial transcripts. See Interim Results for details.

string

default:"100"

Silence detection in ms for engines that support endpointing. "false" to disable. See Endpointing for details.

string

PII redaction. Deepgram only. See Redaction for details.

string

Comma-separated boost terms. Deepgram Nova-3/Flux. See Keyword Boosting for details.

string

Legacy keyword boosting with intensifiers. Deepgram Nova. See Keyword Boosting for details.

string

default:"eastus"

Azure Speech Services region.

float

default:"0.7"

Flux only. Confidence threshold for EndOfTurn events. See End-of-Turn Detection for details.

integer

default:"5000"

Flux only. Max silence before forcing EndOfTurn. See End-of-Turn Detection for details.

float

Flux only. Speculative EagerEndOfTurn threshold. Disabled by default. See End-of-Turn Detection for details.

Example

wss://api.telnyx.com/v2/speech-to-text/transcription?transcription_engine=Deepgram&model=nova-3&input_format=wav&language=en-US&interim_results=true