Orpheus WS Stream
Real-time text-to-speech synthesis using Orpheus model via WebSocket connection. Uses SLNG unified protocol with graceful degradation - same client code works across all TTS providers. Supports both unified parameters and legacy SLNG-specific parameters for backward compatibility.
query Parameters
voice_id
string🔄 UNIFIED: Voice identifier. Standard parameter that works across all TTS providers. For Orpheus: maps to SLNG-hosted model voice parameter.
Default: tararegion
string · enum🔄 UNIFIED: Compute region for processing
Enum values:us-westus-easteu-westDefault: us-westsample_rate_hz
integer · enum🔄 UNIFIED: Audio sample rate in Hz
Enum values:8000160002400048000Default: 24000codec
string · enum🔄 UNIFIED: Audio codec format
Enum values:pcm16opusDefault: pcm16voice
string⚠️ LEGACY: SLNG-hosted model specific voice parameter. Use 'voice_id' for unified protocol compatibility.
buffer_size
integer⚠️ LEGACY: SLNG-hosted model buffer size (words before auto-flush). Use unified 'configure' commands in protocol instead.
Default: 10temperature
number · min: 0 · max: 1⚠️ LEGACY: SLNG-hosted model temperature (synthesis variability). Use unified TTS extension 'style' parameters in init command.
Default: 0.6
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE
.Upgrade
string · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnection
string · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established
Kokoro WS Stream
Real-time text-to-speech synthesis using Kokoro model via WebSocket connection. High-quality Japanese and English voice synthesis with emotion control.
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE
.Upgrade
string · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnection
string · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established
CosyVoice WS Stream
Real-time text-to-speech synthesis using CosyVoice model via WebSocket connection. Advanced voice cloning and multi-speaker capabilities.
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE
.Upgrade
string · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnection
string · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established
Chatterbox WS Stream
Real-time text-to-speech synthesis using Chatterbox model via WebSocket connection. Uses SLNG unified protocol with graceful degradation - same client code works across all TTS providers.
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE
.Upgrade
string · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnection
string · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established
XTTS-V2 WS Stream
Real-time text-to-speech synthesis using XTTS-V2 model via WebSocket. Advanced voice cloning with multilingual support and custom speaker training.
query Parameters
model
stringModel variant (xtts, xtts-v2)
voice
stringSpeaker name or voice ID
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE
.
Responses
Switching Protocols
Orpheus Indic WS Stream
Real-time text-to-speech synthesis for 8 Indic languages using Orpheus Indic model via WebSocket. Supports Hindi, Bengali, Tamil, Telugu, Marathi, Gujarati, Kannada, and Malayalam with native pronunciation and prosody.
query Parameters
voice_id
string · enumVoice identifier for Indic languages. Supports voices optimized for Hindi, Bengali, Tamil, Telugu, Marathi, Gujarati, Kannada, and Malayalam.
Enum values:kanakdivyaarjunpriyaamitneharahulananyaDefault: kanaklanguage
string · enumIndic language code. Supports 8 major Indian languages.
Enum values:hibntatemrguknmlDefault: hiregion
string · enumCompute region for processing
Enum values:us-westus-easteu-westap-southDefault: us-west
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE
.Upgrade
string · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnection
string · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established
Kyutai TTS WS Stream
Real-time text-to-speech synthesis using Kyutai model via WebSocket. Supports English and French with configurable buffer processing. Outputs 24kHz 16-bit PCM mono audio.
query Parameters
language
string · enumLanguage for synthesis (English or French)
Enum values:enfrDefault: enbuffer_size
integer · min: 10 · max: 200Text buffer size in words (10-200)
Default: 10
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE
.Upgrade
string · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnection
string · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established