Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json
text
string
required

Text to speak, 1-2,000 characters.

Required string length: 1 - 2000
Example:

"مرحبا، كيف يمكنني مساعدتك اليوم؟"

voiceId
string<uuid>
required

ID of a voice from the voice catalog, or one of your cloned voices.

Example:

"078338c4-7788-4371-95d4-1bbe45021113"

sampleRate
enum<string>
default:8k

Output sample rate: 8k (8 kHz, telephony) or 16k (16 kHz).

Available options:
8k,
16k
Example:

"8k"

expressiveness
number
default:1
deprecated

Deprecated. Still accepted (0 to 2, default 1) so existing requests keep working; don't build on it. For emotion and casual delivery, use the v3 connector route and its emotion and casual fields.

Required range: 0 <= x <= 2
Example:

1

model
enum<string>
default:default

default, or hamsa-tts-en for the English model. Any other value uses default.

Available options:
default,
hamsa-tts-en

Response

WAV audio stream (chunked).

The response is of type file.