OpenAITTSConfig

Configuration for the OpenAITTS provider.

Defined in: src/providers/tts/openai/OpenAITTS.ts:75

Configuration for the OpenAITTS 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: OpenAITTSConfig = {
  apiKey: 'sk-xxxxxxxxxxxx',
  model: 'tts-1',
  voice: 'nova',
  responseFormat: 'mp3',
  speed: 1.0,
};

// Via proxy server
const proxyConfig: OpenAITTSConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/openai',
  model: 'tts-1-hd',
  voice: 'alloy',
};

See

OpenAITTSVoice - Available voice options.
OpenAITTSFormat - Available audio format options.

Extends

TTSProviderConfig

Properties

Property	Type	Default value	Description	Overrides	Inherited from	Defined in
`apiKey?`	`string`	`undefined`	API key or authentication token for the provider. Remarks For client-side usage, consider using a proxy server to keep API keys secure. The SDK provides Express, Next.js, and Node adapters for this purpose.	-	`TTSProviderConfig`.`apiKey`	src/core/types/providers.ts:67
`authType?`	`"token"` \| `"bearer"`	`Provider-specific (typically 'token' for Deepgram, ignored for REST providers)`	Authentication type for providers that support multiple auth mechanisms. Remarks Controls how the `apiKey` is sent to the provider: - `'token'` — WebSocket subprotocol `['token', apiKey]` or header `Authorization: Token <key>`. This is the default for Deepgram providers. - `'bearer'` — WebSocket subprotocol `['bearer', token]` or header `Authorization: Bearer <token>`. Use this for OAuth tokens or providers that expect Bearer auth. REST/SDK providers (Anthropic, OpenAI) handle auth through their SDK constructors and ignore this field.	-	`TTSProviderConfig`.`authType`	src/core/types/providers.ts:111
`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:122
`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
`maxRetries?`	`number`	`3`	Maximum number of retries for failed API requests.	-	-	src/providers/tts/openai/OpenAITTS.ts:125
`model?`	`string`	`'tts-1'`	The TTS model to use. Remarks - `'tts-1'` — Optimized for speed and low latency - `'tts-1-hd'` — Optimized for audio quality	`TTSProviderConfig`.`model`	-	src/providers/tts/openai/OpenAITTS.ts:85
`organizationId?`	`string`	`undefined`	OpenAI organization ID for billing attribution.	-	-	src/providers/tts/openai/OpenAITTS.ts:118
`outputFormat?`	`string`	`undefined`	Output audio format identifier. Remarks Provider-specific format string (e.g., `'linear16'`, `'mp3'`, `'opus'`).	-	`TTSProviderConfig`.`outputFormat`	src/core/types/providers.ts:1088
`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:1080
`proxyUrl?`	`string`	`undefined`	URL of a CompositeVoice proxy server endpoint for this provider. Remarks When set, requests are routed through the proxy which injects the real API key server-side. This keeps API keys out of the browser. For WebSocket providers the HTTP URL is automatically converted to `ws(s)://`. At least one of `apiKey` or `proxyUrl` must be set for providers that require authentication (all except NativeSTT, NativeTTS, and WebLLM). Example `proxyUrl: 'http://localhost:3000/api/proxy/deepgram'`	-	`TTSProviderConfig`.`proxyUrl`	src/core/types/providers.ts:93
`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:1072
`responseFormat?`	`OpenAITTSFormat`	`'mp3'`	The audio output format. See OpenAITTSFormat	-	-	src/providers/tts/openai/OpenAITTS.ts:101
`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:1097
`speed?`	`number`	`1.0`	Speech speed multiplier. Remarks Accepted range is 0.25 to 4.0, where 1.0 is normal speed.	-	-	src/providers/tts/openai/OpenAITTS.ts:111
`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:131
`voice?`	`OpenAITTSVoice`	`'alloy'`	The voice to use for synthesis. See OpenAITTSVoice	`TTSProviderConfig`.`voice`	-	src/providers/tts/openai/OpenAITTS.ts:93