AssemblyAISTTConfig

Configuration options for the AssemblyAISTT provider.

Defined in: src/providers/stt/assemblyai/AssemblyAISTT.ts:42

Configuration options for the AssemblyAISTT provider.

Remarks

Extends STTProviderConfig with AssemblyAI-specific settings. You must provide either apiKey (for direct browser-to-AssemblyAI connections) or proxyUrl (for a 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: AssemblyAISTTConfig = {
  apiKey: 'aai_abc123...',
  sampleRate: 16000,
  language: 'en',
};

// Proxy connection (recommended for production)
const config: AssemblyAISTTConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/assemblyai',
  sampleRate: 16000,
  wordBoost: ['CompositeVoice', 'Deepgram'],
};

See

AssemblyAISTT for the provider class

Extends

STTProviderConfig

Properties

Property	Type	Default value	Description	Overrides	Inherited from	Defined in
`apiKey?`	`string`	`undefined`	AssemblyAI API key. Required when connecting directly to AssemblyAI. Omit when using `proxyUrl` — the proxy server supplies the key.	`STTProviderConfig`.`apiKey`	-	src/providers/stt/assemblyai/AssemblyAISTT.ts:48
`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.	-	`STTProviderConfig`.`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.	-	`STTProviderConfig`.`endpoint`	src/core/types/providers.ts:75
`interimResults?`	`boolean`	`undefined`	Whether 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`.`interimResults`	src/core/types/providers.ts:352
`keywords?`	`string`[]	`undefined`	Custom 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`.`keywords`	src/core/types/providers.ts:366
`language?`	`string`	`undefined`	Language code for transcription. Default `'en'`	`STTProviderConfig`.`language`	-	src/providers/stt/assemblyai/AssemblyAISTT.ts:68
`model?`	`string`	`undefined`	Model to use for transcription. Remarks Provider-specific model identifier (e.g., `'nova-3'` for Deepgram).	-	`STTProviderConfig`.`model`	src/core/types/providers.ts:343
`proxyUrl?`	`string`	`undefined`	URL of the CompositeVoice proxy server’s AssemblyAI endpoint. Example: `'http://localhost:3000/api/proxy/assemblyai'`	-	-	src/providers/stt/assemblyai/AssemblyAISTT.ts:53
`punctuation?`	`boolean`	`undefined`	Whether to enable automatic punctuation in transcription results.	-	`STTProviderConfig`.`punctuation`	src/core/types/providers.ts:357
`sampleRate?`	`number`	`undefined`	Audio sample rate in Hz. Default `16000`	-	-	src/providers/stt/assemblyai/AssemblyAISTT.ts:58
`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.	-	`STTProviderConfig`.`timeout`	src/core/types/providers.ts:95
`wordBoost?`	`string`[]	`undefined`	Optional list of words to boost recognition accuracy. AssemblyAI will prioritize these words during transcription.	-	-	src/providers/stt/assemblyai/AssemblyAISTT.ts:63