DeepgramTTSConfig
Configuration for the DeepgramTTS provider.
Defined in: src/providers/tts/deepgram/DeepgramTTS.ts:86
Configuration for the DeepgramTTS provider.
Remarks
Provide either apiKey (for direct API access) or proxyUrl (for server-side proxy). At least one must be set. If both are provided, proxyUrl takes precedence and the API key is not sent to the client.
Example
// Direct API access
const config: DeepgramTTSConfig = {
apiKey: 'dg-xxxxxxxxxxxx',
voice: 'aura-2-thalia-en',
sampleRate: 24000,
outputFormat: 'linear16',
};
// Via proxy server
const proxyConfig: DeepgramTTSConfig = {
proxyUrl: 'http://localhost:3001/api/proxy/deepgram',
voice: 'aura-2-andromeda-en',
};
See
DeepgramTTSOptions - Additional Deepgram-specific synthesis options.
Extends
Properties
| Property | Type | Default value | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|
apiKey? | string | undefined | Deepgram API key for direct authentication. Remarks Required when connecting directly to Deepgram (no proxy). Omit when using proxyUrl — the proxy server supplies the key server-side. | TTSProviderConfig.apiKey | - | src/providers/tts/deepgram/DeepgramTTS.ts:94 |
debug? | boolean | false | Whether to enable debug logging for this provider. Remarks When true, the provider emits detailed internal logs. This is separate from the SDK-level LoggingConfig. | - | TTSProviderConfig.debug | src/core/types/providers.ts:86 |
endpoint? | string | undefined | Custom endpoint URL to override the provider’s default API endpoint. Remarks Useful for self-hosted instances, proxy servers, or development environments. | - | TTSProviderConfig.endpoint | src/core/types/providers.ts:75 |
model? | string | undefined | Model to use for text-to-speech synthesis. Remarks Provider-specific model identifier (e.g., 'aura-2' for Deepgram). | - | TTSProviderConfig.model | src/core/types/providers.ts:975 |
options? | DeepgramTTSOptions | undefined | Additional Deepgram-specific TTS options. Remarks Options here override the top-level voice, sampleRate, and outputFormat values when both are provided. See DeepgramTTSOptions | - | - | src/providers/tts/deepgram/DeepgramTTS.ts:116 |
outputFormat? | string | undefined | Output audio format identifier. Remarks Provider-specific format string (e.g., 'linear16', 'mp3', 'opus'). | - | TTSProviderConfig.outputFormat | src/core/types/providers.ts:1000 |
pitch? | number | undefined | Pitch adjustment in semitones. Remarks Values from -20 to +20 semitones. Not all providers support pitch adjustment. | - | TTSProviderConfig.pitch | src/core/types/providers.ts:992 |
proxyUrl? | string | undefined | URL of the CompositeVoice proxy server’s Deepgram endpoint. Remarks When set, the WebSocket connection is routed through the proxy and the apiKey is not required on the client side. Example 'http://localhost:3001/api/proxy/deepgram' | - | - | src/providers/tts/deepgram/DeepgramTTS.ts:105 |
rate? | number | undefined | Speech rate multiplier. Remarks Values from 0.25 (quarter speed) to 4.0 (quadruple speed), where 1.0 is normal speed. Not all providers support rate adjustment. | - | TTSProviderConfig.rate | src/core/types/providers.ts:984 |
sampleRate? | number | undefined | Sample rate for the output audio in Hz. Remarks Common values are 16000, 24000, and 48000. Must match the format capabilities of the chosen voice and model. | - | TTSProviderConfig.sampleRate | src/core/types/providers.ts:1009 |
timeout? | number | undefined | Request timeout in milliseconds. Remarks Applies to HTTP requests (REST providers) and connection establishment (WebSocket providers). Set to 0 for no timeout. | - | TTSProviderConfig.timeout | src/core/types/providers.ts:95 |
voice? | string | undefined | Voice ID or name to use for synthesis. Remarks Provider-specific voice identifier. For example, Deepgram uses identifiers like 'aura-asteria-en', while ElevenLabs uses voice IDs. | - | TTSProviderConfig.voice | src/core/types/providers.ts:967 |