Skip to main content
POST

Authorizations

​
Authorization
string
header
required

your rumik API key, e.g. rk_live_.... create one in the rumik dashboard.

Body

application/json
​
text
string
required

text to synthesize. up to 2000 characters. for muga, prefix with a tone tag, e.g. [happy].

Maximum string length: 2000
Example:

"[happy] Namaste! Kaise hain aap?"

​
model
enum<string>
default:muga

which model to use. muga is steered by a tone tag in the text; mulberry is steered by a natural-language description.

Available options:
muga,
mulberry
​
description
string

required for mulberry. natural-language voice/style description. the voice is built from this. send it on every mulberry request, including when speaker is set. not used by muga.

Example:

"a female 30s hindi voice, smooth timbre, conversational pacing, like a podcast host"

​
speaker
enum<string>

mulberry only. optional named voice. emma, mia, sophia, ava, ira, siya, aisha and zoya are female; lucas, noah, theo and adam are male. case-insensitive. omit and a voice is generated from description. description is required either way.

Available options:
emma,
mia,
sophia,
ava,
ira,
siya,
aisha,
zoya,
lucas,
noah,
theo,
adam
Example:

"siya"

​
temperature
number
default:0.6

sampling temperature.

​
top_p
number
default:0.95

nucleus sampling.

​
top_k
integer
default:50

top-k sampling.

​
repetition_penalty
number
default:1.2

penalize repeated tokens.

​
max_new_tokens
integer
default:2048

output length cap. for mulberry, if long text comes back truncated, raise this above the default 2048 (up to 8192).

Required range: x <= 8192

Response

synthesized audio as a 24 kHz mono WAV.

The response is of type file.