SpeechmaticsSTTConfig

Defined in: src/providers/stt/speechmatics/SpeechmaticsSTT.ts:50

Configuration options for the SpeechmaticsSTT provider.

Remarks

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

For direct browser connections, Speechmatics requires a short-lived temporary key (JWT) passed as a jwt query parameter — browsers cannot set WebSocket headers. Generate temporary keys server-side via POST https://mp.speechmatics.com/v1/api_keys?type=rt and pass an async factory as apiKey to fetch a fresh key on each connection.

Example

// Direct connection with a temporary key factory
const config: SpeechmaticsSTTConfig = {
  apiKey: async () => {
    const res = await fetch('/api/speechmatics-temp-key');
    const { keyValue } = await res.json();
    return keyValue;
  },
  language: 'en',
};

// Proxy connection (recommended for production)
const config: SpeechmaticsSTTConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/speechmatics',
  language: 'en',
};

See

SpeechmaticsSTT for the provider class

Extends

• STTProviderConfig

Properties