Skip to main content
POST
Create a voice over from your script

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
voiceOverText
string
required

The script: 1 to 1000 characters.

Required string length: 1 - 1000
Example:

"ابدأ يومك بقهوة تستحقها، في قلب القاهرة."

ttsVoiceId
string<uuid>
required

The voice: a public Hamsa Media voice, a voice in this project, or one of your own.

Example:

"6a1f0c2e-8b7d-4e3a-9c5b-2d4f6e8a0b13"

type
enum<string>
required

The kind of voice over. It decides which background music fits.

Available options:
POETRY,
COMMERCIAL,
RELIGIOUS,
STORIES
Example:

"COMMERCIAL"

voiceOverBackgroundMusicId
string

A track from List Background Music (of the same type), or auto to let Hamsa pick one and time it. Leave it out for no music.

Example:

"auto"

Response

Started. The take starts as PENDING.

success
boolean
Example:

true

message
string
Example:

"success"

data
object