Skip to main content
POST
Suggest voice over scripts

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
type
enum<string>
required

The kind of voice over. POETRY: a poem (in Arabic, with rhyme and rhythm). COMMERCIAL: an ad, hook to benefits to call to action. RELIGIOUS: a calm, spiritual script. STORIES: a narrated story. The three prose types aim for 30 to 120 seconds (75 to 220 words).

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

"COMMERCIAL"

dialectId
string<uuid>
required

The Arabic dialect of the voices, from List Dialects.

Example:

"2b7e4c9a-1f3d-4a6b-8e5c-0d2f4a6c8e17"

voiceOverDescription
string
required

What the voice over is for: 1 to 1000 characters.

Required string length: 1 - 1000
Example:

"A 30-second ad for a new coffee shop in Cairo"

includeBackgroundMusic
boolean
default:false

Mix background music that suits the type under each take.

Example:

true

Response

Started. The three takes start as PENDING.

success
boolean
Example:

true

message
string
Example:

"success"

data
object