API ReferenceText to Speech API

Continuous Text Stream

Convert text into natural-sounding speech using Deepgram’s TTS WebSocket

HandshakeTry it

WSS
wss://api.deepgram.com/v1/speak

Headers

AuthorizationstringRequired

API key for authentication. Format should be be either ‘token <DEEPGRAM_API_KEY>’ or ‘Bearer <JWT_TOKEN>’

Query parameters

encodingenumOptionalDefaults to mp3
Encoding allows you to specify the expected encoding of your audio output
mip_opt_outstringOptionalDefaults to false

Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip

modelenumOptionalDefaults to aura-asteria-en
AI model used to process submitted text
sample_rateenumOptionalDefaults to 24000
Sample Rate specifies the sample rate for the output audio. Based on encoding 8000 or 24000 are possible defaults. For some encodings sample rate is not configurable.
Allowed values:

Send

sendTextobjectRequired
Send text to Deepgram's Text to Speech API
OR
sendSpeakControlMessageobjectRequired
Send control messages to Deepgram's Text to Speech API

Receive

receiveAudiostringRequiredformat: "binary"
Receive audio from Deepgram's Text to Speech API
OR
receiveSpeakControlResponseobjectRequired
Receive control messages from Deepgram's Text to Speech API
OR
receiveSpeakCloseFrameobjectRequired
Receive close frame from Deepgram's Text to Speech API