Skip to main content
POST

Authorizations

x-user-auth
string
header
required

Your API key from account settings

x-bot
string
header
required

Your bot ID from account settings

Body

application/json
TextMessage
string
required

Text to convert to speech

Example:

"وش علومك اليوم؟"

LanguageCode
string
required

Language code for speech synthesis

Example:

"ar-sa"

Speaker
string
required

Voice to use for speech generation

Example:

"Rawy"

ModelType
string
required

Required. Voice model version. One of: v1, v1-fast, v2, v3, v4, or eval-*.

Example:

"v1"

temperature
number<float>

Controls variation in speech generation

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

0.5

output_sr
integer

Output sample rate in Hz

Example:

24000

session_id
string

Optional session identifier

Example:

"example-session-001"

Response

200 - application/json

Text to speech conversion successful

StatusCode
integer
Example:

200

Response
object
Consumption
string

Character usage tracking

Example:

"18/15000"