SpeechifyTTSConfig
Configuration for the SpeechifyTTS provider.
Defined in: src/providers/tts/speechify/SpeechifyTTS.ts:74
Configuration for the SpeechifyTTS 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. The voiceId is always required.
Example
// Direct API access
const config: SpeechifyTTSConfig = {
apiKey: 'sk_xxxxxxxxxxxx',
voiceId: 'geffen_32',
model: 'simba-3.2',
audioFormat: 'mp3',
};
// Via proxy server
const proxyConfig: SpeechifyTTSConfig = {
proxyUrl: 'http://localhost:3001/api/proxy/speechify',
voiceId: 'geffen_32',
};
See
- SpeechifyTTSModel - Available model options.
- SpeechifyTTSFormat - Available audio format options.
Extends
Properties
| Property | Type | Default value | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|
apiKey? | string | () => Promise<string> | undefined | API key or authentication token for the provider. Remarks Can be a static string or an async factory function that returns a fresh token on each call. Use a factory for short-lived tokens (e.g. Deepgram JWTs) so each WebSocket connection gets a valid credential. 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:71 |
audioFormat? | SpeechifyTTSFormat | 'mp3' | The audio output format. See SpeechifyTTSFormat | - | - | src/providers/tts/speechify/SpeechifyTTS.ts:98 |
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:115 |
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:126 |
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:79 |
language? | string | undefined (automatic detection) | Language of the input text. Remarks An ISO 639-1 language code, optionally followed by an ISO 3166-1 region code separated by a hyphen (e.g. 'en-US'). When omitted, Speechify detects the language automatically. | - | - | src/providers/tts/speechify/SpeechifyTTS.ts:110 |
loudnessNormalization? | boolean | false | Whether to apply loudness normalization to the output audio. | - | - | src/providers/tts/speechify/SpeechifyTTS.ts:117 |
maxRetries? | number | 3 | Maximum number of retries for failed API requests. | - | - | src/providers/tts/speechify/SpeechifyTTS.ts:132 |
model? | SpeechifyTTSModel | 'simba-english' | The TTS model to use. See SpeechifyTTSModel | TTSProviderConfig.model | - | src/providers/tts/speechify/SpeechifyTTS.ts:90 |
outputFormat? | string | undefined | Output audio format identifier. Remarks Provider-specific format string (e.g., 'linear16', 'mp3', 'opus'). | - | TTSProviderConfig.outputFormat | src/core/types/providers.ts:1190 |
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:1182 |
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:97 |
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:1174 |
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:1199 |
textNormalization? | boolean | false | Whether to apply text normalization (numbers, dates, abbreviations) before synthesis. | - | - | src/providers/tts/speechify/SpeechifyTTS.ts:125 |
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:135 |
voice? | string | undefined | Voice ID or name to use for synthesis. Remarks Provider-specific voice identifier. For example, Deepgram uses identifiers like 'aura-asteria-en', while ElevenLabs uses voice IDs. | - | TTSProviderConfig.voice | src/core/types/providers.ts:1157 |
voiceId | string | undefined | The voice to use for synthesis. Remarks Required. List available voices via Speechify’s GET /v1/voices endpoint, or use a cloned voice ID. | - | - | src/providers/tts/speechify/SpeechifyTTS.ts:82 |