Skip to content

DeepgramSTTConfig

Configuration options for the DeepgramSTT provider.

Defined in: src/providers/stt/deepgram/DeepgramSTT.ts:191

Configuration options for the DeepgramSTT provider.

Remarks

Extends STTProviderConfig with Deepgram-specific settings. You must provide either apiKey (for direct browser-to-Deepgram connections) or proxyUrl (for server-side proxy that injects the API key). If both are provided, proxyUrl takes precedence.

Example

// Direct connection (API key exposed to browser -- development only)
const config: DeepgramSTTConfig = {
  apiKey: 'dg_abc123...',
  options: { model: 'nova-3', smartFormat: true },
};

// Proxy connection (recommended for production)
const config: DeepgramSTTConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/deepgram',
  options: { model: 'nova-3', punctuation: true },
};

See

Extends

Properties

PropertyTypeDefault valueDescriptionOverridesInherited fromDefined in
apiKey?stringundefinedDeepgram API key. Required when connecting directly to Deepgram. Omit when using proxyUrl — the proxy server supplies the key.STTProviderConfig.apiKey-src/providers/stt/deepgram/DeepgramSTT.ts:197
debug?booleanfalseWhether to enable debug logging for this provider. Remarks When true, the provider emits detailed internal logs. This is separate from the SDK-level LoggingConfig.-STTProviderConfig.debugsrc/core/types/providers.ts:86
endpoint?stringundefinedCustom endpoint URL to override the provider’s default API endpoint. Remarks Useful for self-hosted instances, proxy servers, or development environments.-STTProviderConfig.endpointsrc/core/types/providers.ts:75
interimResults?booleanundefinedWhether to enable interim (partial) transcription results. Remarks When true, the provider emits results as the user speaks, before the utterance is complete. Only applicable to live/WebSocket providers.-STTProviderConfig.interimResultssrc/core/types/providers.ts:352
keywords?string[]undefinedCustom vocabulary or keyword phrases to boost recognition accuracy. Remarks Useful for domain-specific terminology, product names, or proper nouns that the model might not recognize well by default.-STTProviderConfig.keywordssrc/core/types/providers.ts:366
language?stringundefinedLanguage code for transcription. Remarks Uses BCP 47 language tags (e.g., 'en-US', 'es-ES', 'fr-FR'). The supported languages depend on the provider and model.-STTProviderConfig.languagesrc/core/types/providers.ts:335
model?stringundefinedModel to use for transcription. Remarks Provider-specific model identifier (e.g., 'nova-3' for Deepgram).-STTProviderConfig.modelsrc/core/types/providers.ts:343
options?DeepgramTranscriptionOptionsundefinedDeepgram transcription options--src/providers/stt/deepgram/DeepgramSTT.ts:208
proxyUrl?stringundefinedURL of the CompositeVoice proxy server’s Deepgram endpoint. Example: 'http://localhost:3000/api/proxy/deepgram' When set, the WebSocket connects through this URL instead of wss://api.deepgram.com, allowing browsers to reach Deepgram through a same-origin proxy that injects the real API key server-side.--src/providers/stt/deepgram/DeepgramSTT.ts:206
punctuation?booleanundefinedWhether to enable automatic punctuation in transcription results.-STTProviderConfig.punctuationsrc/core/types/providers.ts:357
timeout?numberundefinedRequest timeout in milliseconds. Remarks Applies to HTTP requests (REST providers) and connection establishment (WebSocket providers). Set to 0 for no timeout.-STTProviderConfig.timeoutsrc/core/types/providers.ts:95

© 2026 CompositeVoice. All rights reserved.

Font size
Contrast
Motion
Transparency