Skip to main content
POST
Make a video from a voice over

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 '

Path Parameters

id
string<uuid>
required

The voice over.

Example:

"bd0ebca4-a16e-488b-b195-4690792259c7"

Body

application/json
voiceOverSuggestionId
string<uuid>
required

The approved take.

Example:

"c816c6f6-9d49-4b5d-8c87-4a7a24fc8af1"

style
enum<string>
required

The look of the images. CARTOON picks one of three cartoon styles at random.

Available options:
REALISTIC,
CARTOON,
INFO_GRAPHIC
Example:

"REALISTIC"

aspectRatio
enum<string>
default:9:16
Available options:
9:16,
16:9
Example:

"9:16"

includeSubtitles
boolean
default:true
Example:

true

captionStyle
enum<string>

How captions appear. Required while includeSubtitles is true; ignored otherwise.

Available options:
WORD_BY_WORD,
BUILD_UP,
FULL_SENTENCE
Example:

"WORD_BY_WORD"

captionBox
boolean
default:true

A rounded box behind the captions.

Example:

true

transition
enum<string>

The transition between images. Leave it out for straight cuts.

Available options:
FADE,
DISSOLVE,
SLIDE_LEFT,
SLIDE_RIGHT,
CIRCLE_OPEN,
WIPE_LEFT,
ZOOM_IN
Example:

"FADE"

kenBurnsEnabled
boolean
default:false

A slow zoom on each image.

Example:

false

prompt
string

Design guidance applied to every image, up to 1000 characters.

Maximum string length: 1000
Example:

"Warm morning light, a busy street café"

Response

Started.

success
boolean
Example:

true

message
string
Example:

"voice over video generation started"

messageKey
string
Example:

"VoiceOverVideoGenerationStarted"

data
object