Skip to main content

​
DeepgramTTS

Deepgram text-to-speech (TTS) provider. Creates a configured Deepgram TTS instance for use in a voice agent.

​
Constructor

​
apiKey
string | null
Deepgram API key. Falls back to the DEEPGRAM_API_KEY environment variable, then null if neither is set.
​
model
DeepgramTTSModel | string
default:"aura-2-andromeda-en"
Deepgram Aura voice/model id (e.g. 'aura-2-andromeda-en').
​
voice
string
default:"model"
Voice id to synthesize with. Defaults to the value of model.
​
language
string
default:"en"
Language code for synthesis (e.g. 'en').
​
sampleRate
number
default:"24000"
Output audio sample rate in Hz.
​
stream
boolean
default:"true"
Stream audio from the model.
​
encoding
string
default:"linear16"
Output audio encoding.
​
baseUrl
string
default:"wss://api.deepgram.com/v1/speak"
Deepgram Speak WebSocket endpoint.

​
close

Release any resources held by the provider.

​
closeEmitter

Close the emitter: drop all handlers and stop emitting. Waits up to 2 seconds for in-flight async handlers to settle before returning.

​
emit

​
event
string
required

​
getRuntimeConfig

​
returns
Record<string, any>

​
interrupt

Stop the current synthesis.

​
listenerCount

​
event
string
required
​
returns
number

​
off

​
event
string
required
​
handler
EventHandler
required

​
on

​
event
string
required
​
handler
EventHandler
required
​
returns
EventHandler

​
once

​
event
string
required
​
handler
EventHandler
required
​
returns
EventHandler

​
onFirstAudioByte

Register a callback fired when the first synthesized audio byte is emitted.
​
callback
FirstAudioByteCallback
required

​
removeAllListeners

​
event
string

​
synthesize

Synthesize and speak text on the active session.
​
text
any
required

​
DeepgramTTSModel

Supported Deepgram text-to-speech model names.