SonioxSTTConfig

Defined in: src/providers/stt/soniox/SonioxSTT.ts:48

Configuration options for the SonioxSTT provider.

Remarks

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

For direct browser connections, Soniox recommends temporary API keys generated server-side. Pass an async factory as apiKey to fetch a fresh temporary key on each connection.

Example

// Direct connection with a temporary API key factory
const config: SonioxSTTConfig = {
  apiKey: async () => {
    const res = await fetch('/api/soniox-temp-key');
    const { apiKey } = await res.json();
    return apiKey;
  },
  sampleRate: 16000,
};

// Proxy connection (recommended for production)
const config: SonioxSTTConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/soniox',
  languageHints: ['en', 'es'],
};

See

SonioxSTT for the provider class

Extends

• STTProviderConfig

Properties