SILMA TTS v2 API

• The text to synthesize into speech (up to 1000 characters).
• To pronounce phone numbers correctly use <STAG_PN>92005455</STAG_PN>
• To pronounce emails correctly use <STAG_EMAIL>test@silma.ai</STAG_EMAIL>
• To pronounce links correctly use <STAG_LINK>www.silma.ai</STAG_LINK>
• To insert a pause use the SSML break tag, e.g. <break time="500ms"/> or <break time="1.5s"/> (max 5s per pause; a bare <break/> pauses 0.5s). Only the “time” attribute is supported.
• Break tags do not count toward the character limit or billed characters.

Variance in speech prosody.

• Deprecated. Kept for backward compatibility and behaves as before.
• Use “speech_rate” to control how fast the voice speaks.

• Speaking rate multiplier. 1.0 is the voice’s natural pace, 1.2 is 20% faster and 0.8 is 20% slower.
• The voice and its pitch stay the same at every rate.

• The ID of the pre-defined voice.
• English voices: [james, emma, isabella, oliver]
• Arabic voices: [abdulaziz, fahd, layla, maryam, nouf, noura, omar, reema, yusuf, khalid]
• Legacy Arabic voices: [salwa, saja, sultan, salman, sulaiman, salim]

Optional user identifier, needed only for pronunciation overrides and loading custom voices. Find it here https://app.silma.ai/api-keys

• The ID representing your uploaded custom voice to be cloned.
• This should be an ID for a voice (ex:voice_1769817467123) in the “Custom Voices” section in https://app.silma.ai/voices.
• If you use this parameter then you should use the “user_id” parameter as well.

This indicates that you have added custom pronunciation overrides to your account via https://app.silma.ai/control. Enabling this feature will automatically customize the model based on your overrides.

• Pronunciation overrides and cached audio (see “enable_cache”) are cached on the server.
• Set this to true on a single request to drop all of your cached overrides and cached audio. Overrides are then re-read from storage and the audio is generated again.
• The UI sends this when you edit your pronunciation overrides. Otherwise, the server uses cached audio and overrides, which keeps the old pronunciation. You typically don’t need to use this unless you want to intentionally invalidate all cached audio and overrides for some reason.

• Cache the generated audio on the server and return it from the cache for identical requests, instead of generating it again.
• Requests are identical when they call the same endpoint with the same “model_id”, “voice_id”, “text”, “speed”, “speech_rate”, “creativity”, “quality_to_inference_speed_ratio”, “custom_audio_id” and “enable_server_pronunciation_overrides”, from the same account.
• Cached responses are billed half the characters (rounded up).
• Cached audio is private to your account and kept for up to 30 days. Use “invalidate_user_cache” to drop it.
• The “X-Cache” response header is “HIT” when the response came from the cache, “MISS” when it was generated, and “BYPASS” when caching was not requested.

• The text to synthesize into speech (up to 1000 characters).
• To pronounce phone numbers correctly use <STAG_PN>92005455</STAG_PN>
• To pronounce emails correctly use <STAG_EMAIL>test@silma.ai</STAG_EMAIL>
• To pronounce links correctly use <STAG_LINK>www.silma.ai</STAG_LINK>
• To insert a pause use the SSML break tag, e.g. <break time="500ms"/> or <break time="1.5s"/> (max 5s per pause; a bare <break/> pauses 0.5s). Only the “time” attribute is supported.
• Break tags do not count toward the character limit or billed characters.

Variance in speech prosody.

• Deprecated. Kept for backward compatibility and behaves as before.
• Use “speech_rate” to control how fast the voice speaks.

• Speaking rate multiplier. 1.0 is the voice’s natural pace, 1.2 is 20% faster and 0.8 is 20% slower.
• The voice and its pitch stay the same at every rate.

• The ID of the pre-defined voice.
• English voices: [james, emma, isabella, oliver]
• Arabic voices: [abdulaziz, fahd, layla, maryam, nouf, noura, omar, reema, yusuf, khalid]
• Legacy Arabic voices: [salwa, saja, sultan, salman, sulaiman, salim]

Optional user identifier, needed only for pronunciation overrides and loading custom voices. Find it here https://app.silma.ai/api-keys

• The ID representing your uploaded custom voice to be cloned.
• This should be an ID for a voice (ex:voice_1769817467123) in the “Custom Voices” section in https://app.silma.ai/voices.
• If you use this parameter then you should use the “user_id” parameter as well.

This indicates that you have added custom pronunciation overrides to your account via https://app.silma.ai/control. Enabling this feature will automatically customize the model based on your overrides.

• Pronunciation overrides and cached audio (see “enable_cache”) are cached on the server.
• Set this to true on a single request to drop all of your cached overrides and cached audio. Overrides are then re-read from storage and the audio is generated again.
• The UI sends this when you edit your pronunciation overrides. Otherwise, the server uses cached audio and overrides, which keeps the old pronunciation. You typically don’t need to use this unless you want to intentionally invalidate all cached audio and overrides for some reason.

• Cache the generated audio on the server and return it from the cache for identical requests, instead of generating it again.
• Requests are identical when they call the same endpoint with the same “model_id”, “voice_id”, “text”, “speed”, “speech_rate”, “creativity”, “quality_to_inference_speed_ratio”, “custom_audio_id” and “enable_server_pronunciation_overrides”, from the same account.
• Cached responses are billed half the characters (rounded up).
• Cached audio is private to your account and kept for up to 30 days. Use “invalidate_user_cache” to drop it.
• The “X-Cache” response header is “HIT” when the response came from the cache, “MISS” when it was generated, and “BYPASS” when caching was not requested.

• The format of the returned audio file: “wav” (16-bit mono PCM) or “mp3” (128 kbps mono).
• “enable_cache” is ignored: every /generate request is generated.

• The text to synthesize into speech (up to 250 characters).
• To pronounce phone numbers correctly use <STAG_PN>92005455</STAG_PN>
• To pronounce emails correctly use <STAG_EMAIL>test@silma.ai</STAG_EMAIL>
• To pronounce links correctly use <STAG_LINK>www.silma.ai</STAG_LINK>
• To insert a pause use the SSML break tag, e.g. <break time="500ms"/> or <break time="1.5s"/> (max 5s per pause; a bare <break/> pauses 0.5s). Only the “time” attribute is supported.
• Break tags do not count toward the character limit or billed characters.

Variance in speech prosody.

• Deprecated. Kept for backward compatibility and behaves as before.
• Use “speech_rate” to control how fast the voice speaks.

• Speaking rate multiplier. 1.0 is the voice’s natural pace, 1.2 is 20% faster and 0.8 is 20% slower.
• The voice and its pitch stay the same at every rate.

• The ID of the pre-defined voice.
• English voices: [james, emma, isabella, oliver]
• Arabic voices: [abdulaziz, fahd, layla, maryam, nouf, noura, omar, reema, yusuf, khalid]
• Legacy Arabic voices: [salwa, saja, sultan, salman, sulaiman, salim]

Optional user identifier, needed only for pronunciation overrides and loading custom voices. Find it here https://app.silma.ai/api-keys

• The ID representing your uploaded custom voice to be cloned.
• This should be an ID for a voice (ex:voice_1769817467123) in the “Custom Voices” section in https://app.silma.ai/voices.
• If you use this parameter then you should use the “user_id” parameter as well.

This indicates that you have added custom pronunciation overrides to your account via https://app.silma.ai/control. Enabling this feature will automatically customize the model based on your overrides.

• Pronunciation overrides and cached audio (see “enable_cache”) are cached on the server.
• Set this to true on a single request to drop all of your cached overrides and cached audio. Overrides are then re-read from storage and the audio is generated again.
• The UI sends this when you edit your pronunciation overrides. Otherwise, the server uses cached audio and overrides, which keeps the old pronunciation. You typically don’t need to use this unless you want to intentionally invalidate all cached audio and overrides for some reason.

• Cache the generated audio on the server and return it from the cache for identical requests, instead of generating it again.
• Requests are identical when they call the same endpoint with the same “model_id”, “voice_id”, “text”, “speed”, “speech_rate”, “creativity”, “quality_to_inference_speed_ratio”, “custom_audio_id” and “enable_server_pronunciation_overrides”, from the same account.
• Cached responses are billed half the characters (rounded up).
• Cached audio is private to your account and kept for up to 30 days. Use “invalidate_user_cache” to drop it.
• The “X-Cache” response header is “HIT” when the response came from the cache, “MISS” when it was generated, and “BYPASS” when caching was not requested.