WebSocket

Streaming Speech-to-Text

Handshake

GET

Headers

AuthenticationstringOptional

Query parameters

sample_rateintegerOptional
The sample rate of the streamed audio
word_booststringOptional
Add up to 2500 characters of custom vocabulary. The parameter value must be a JSON encoded array of strings.
encodingenumOptional
The encoding of the audio data
Allowed values: pcm_s16lepcm_mulaw
tokenstringOptional

Authenticate using a generated temporary token

disable_partial_transcriptsbooleanOptional
Set to true to not receive partial transcripts. Defaults to false.
enable_extra_session_informationbooleanOptional
Set to true to receive the SessionInformation message before the session ends. Defaults to false.

Send

abc
Audio Datastring
OR
Terminate Sessionobject
OR
Force End Utteranceobject
OR
Configure End Utterance Silence Thresholdobject

Receive

Session Beginsobject
OR
Partial Transcriptobject
OR
Final Transcriptobject
OR
Session Informationobject
OR
Session Terminatedobject
OR
Realtime Errorobject