WebSocket

WebSocket channel for real-time speech to text streaming.

Note: This API Reference page is provided for informational purposes only. The Try It playground may not provide the best experience for streaming audio. For optimal streaming performance, please use the SDK or implement your own WebSocket client.

HandshakeTry it

WSS
wss://api.sarvam.ai/speech-to-text/ws

Headers

Api-Subscription-KeystringRequired
API subscription key for authentication

Query parameters

language-codeenumRequired
Language code for speech recognition
modelenumOptionalDefaults to saarika:v2.5
Speech to text model to use
Allowed values:
sample_rateenumOptional
Audio sample rate for the WebSocket connection. When specified as a connection parameter, only 16kHz and 8kHz are supported. 8kHz is only available via this connection parameter. If not specified, defaults to 16kHz.
Allowed values:
high_vad_sensitivityenumOptional

Enable high VAD (Voice Activity Detection) sensitivity

Allowed values:
vad_signalsenumOptional
Enable VAD signals in response
Allowed values:
flush_signalenumOptional
Signal to flush the audio buffer and finalize transcription
Allowed values:

Send

Audio Transcription MessageobjectRequired

Send audio data for real-time speech to text streaming

OR
Speech Flush SignalobjectRequired
Send signal to flush audio buffer and finalize transcription

Receive

TranscriptionobjectRequired

Receive real-time transcription results from the WebSocket