Skip to main content

Usage guide

Setup, environment variables, and Python/JavaScript/Go usage examples.

​
DeepgramTTS

Low-latency streaming text-to-speech via Deepgram’s Aura-2 Speak API. Natural English neural voices selected by model id (one voice per model).

​
Constructor

​
api_key
str | None
Deepgram API key. Falls back to DEEPGRAM_API_KEY.
​
voice
Optional[str]
Voice override; when set, takes precedence over model as the Aura voice id. Defaults to the model value.
​
model
DeepgramTTSModel | str
default:"aura-2-andromeda-en"
Aura-2 voice, e.g. aura-2-andromeda-en, aura-2-thalia-en, aura-2-asteria-en, aura-2-zeus-en (16 English voices). Default "aura-2-andromeda-en".
​
sample_rate
int
default:"24000"
Output rate in Hz. Default 24000.
​
stream
bool
default:"True"
Stream audio as it is synthesized. Default True.
​
encoding
str
default:"linear16"
Output audio encoding. Default "linear16".
​
base_url
str
default:"wss://api.deepgram.com/v1/speak"
Deepgram Speak WebSocket endpoint.

​
aclose

Release any resources held by the provider.

​
emit

Emit an event, invoking all registered handlers with the given arguments. Handlers are called in registration order. Coroutine handlers are scheduled on the running event loop. If the emitter is closed, the call is a no-op.
​
event
T
required
The event to emit.

​
interrupt

Interrupt and cancel the current synthesis for the active session, if any.

​
off

Remove a previously registered handler for an event. If the handler is not registered for the event, the call is a no-op.
​
event
T
required
The event the handler was registered for.
​
callback
Callable[..., Any]
required
The handler to remove.

​
on

Register a handler for an event. Can be used directly by passing a callback, or as a decorator when callback is omitted.
​
event
T
required
The event to listen for.
​
callback
Callable[..., Any] | None
The handler to invoke when the event is emitted. If None, a decorator is returned that registers the decorated function.
​
returns
Callable[..., Any]
The registered callback when callback is provided, otherwise a decorator that registers and returns the function it wraps.

​
on_first_audio_byte

Register the callback invoked when the first audio byte is produced.
​
callback
'Callable[[int, int], Awaitable[None] | None]'
required
A callable, optionally async, invoked with synthesis timing information when the first audio byte is emitted.

​
synthesize

Synthesize the given text into speech. Implementations should convert the text to audio. The default behavior forwards the text to the active session for playback when one is present.
​
text
Any
required
The text to synthesize; coerced to a string if needed.

​
DeepgramTTSModel