Skip to main content
WSS
bearer
type:http

API key issued by SLNG. Pass as Authorization: Bearer <token> in the WebSocket upgrade request headers.

method
type:string

GET

Init (Unmute TTS)
type:object

Initialize Unmute TTS session with voice and configuration.

Text (Unmute TTS)
type:object

Send text to synthesize.

Flush (Unmute TTS)
type:object

End the current turn and synthesize buffered text.

Clear (Unmute TTS)
type:object

Discard queued output for the current turn.

Cancel (Unmute TTS)
type:object

Cancel the current synthesis turn.

Close (Unmute TTS)
type:object

Close the session.

Keepalive (Unmute TTS)
type:object

Keep an idle session open.

Ready (Unmute TTS)
type:object

Unmute TTS session is ready.

Binary Audio Frame
type:object

Raw binary audio frame from Unmute TTS.

Cleared (Unmute TTS)
type:object

Queued output was discarded.

Audio End (Unmute TTS)
type:object

Bare turn boundary after the last audio frame.

Error (Unmute TTS)
type:object

Error occurred during Unmute TTS session.