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_idstring🔄 UNIFIED: Voice identifier. Standard parameter that works across all TTS providers. For Orpheus: maps to SLNG-hosted model voice parameter.
Default: tararegionstring · enum🔄 UNIFIED: Compute region for processing
Enum values:us-westus-easteu-westDefault: us-westsample_rate_hzinteger · enum🔄 UNIFIED: Audio sample rate in Hz
Enum values:8000160002400048000Default: 24000codecstring · enum🔄 UNIFIED: Audio codec format
Enum values:pcm16opusDefault: pcm16voicestring⚠️ LEGACY: SLNG-hosted model specific voice parameter. Use 'voice_id' for unified protocol compatibility.
buffer_sizeinteger⚠️ LEGACY: SLNG-hosted model buffer size (words before auto-flush). Use unified 'configure' commands in protocol instead.
Default: 10temperaturenumber · min: 0 · max: 1⚠️ LEGACY: SLNG-hosted model temperature (synthesis variability). Use unified TTS extension 'style' parameters in init command.
Default: 0.6
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.Upgradestring · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnectionstring · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established
Aura2 EN WS Stream
Real-time Aura-2 English text-to-speech via Modal deployment using SLNG unified WebSocket protocol.
query Parameters
modelstringAura-2 model identifier (voice)
Default: aura-2-thalia-enencodingstring · enumAudio encoding format
Enum values:linear16mp3opusDefault: linear16sample_rateinteger · enumSample rate in Hz
Enum values:160002205024000320004410048000Default: 24000containerstring · enumContainer format
Enum values:nonewavoggDefault: none
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.Upgradestring · enum · requiredMust be 'websocket' for WebSocket upgrade
Enum values:websocketConnectionstring · enum · requiredMust be 'Upgrade' for WebSocket upgrade
Enum values:Upgrade
Responses
Switching Protocols - WebSocket connection established