VideoGen API

Script to video

POST/v1/script-to-video

First, generate AI text-to-speech and relevant background footage. Then, the apiFileId of the generated video is returned. Pass the apiFileId into the GET /get-file endpoint to poll for the exported video, which will take approximately as long as the duration of the exported video.

Request

script

string

required

Script of the video. Supports VideoGen Markup Language (VGML).

voice

string

optional

Name of the voice for AI narration.

Default:

Matilda

voiceVolume

number

optional

Volume level for the voice narration, ranging from 0 (silent) to 1 (loudest).

>= 0<= 1

Default:

musicUrl

string

optional

URL of the background music.

musicVolume

number

optional

Volume level for the background music, ranging from 0 (silent) to 1 (loudest).

>= 0<= 1

Default:

0.15

captionFontName

string

optional

Font name for the captions text.

captionFontSize

number

optional

Font size for the captions text. 35 is tiny, 50 is small, 75 is medium, and 100 is large.

captionFontWeight

number

optional

Font weight for the captions text. Some fonts support 400 (normal) and 700 (bold), whereas other fonts don't support multiple font weights. The rendered font weight will be the supported font weight closest to captionFontWeight.

captionTextColor

#/definitions/3290805

optional

Color of the captions text.

captionTextJustification

enum<string>

optional

Text justification of the captions.

Allowed values:

LEFTCENTERRIGHT

captionVerticalAlignment

enum<string>

optional

Vertical alignment of the captions.

Allowed values:

TOPMIDDLEBOTTOM

captionStrokeColor

#/definitions/3290805

optional

Stroke color of the captions text.

captionStrokeWeight

number

optional

Stroke weight of the captions text. This determines the thickness of the border around each character of text. Normally ranges from 0 (no stroke) to 8 (thick stroke).

captionBackgroundStyleType

enum<string>

optional

Style of the background behind the captions text.

Allowed values:

RECTWRAPPED

captionBackgroundColor

#/definitions/3290805

optional

Color of the background behind the captions text.

captionBackgroundBorderRadius

number

optional

Border radius of the background behind the captions text, as a proportion of the smaller side length.

>= 0<= 1

captionBackgroundOpacity

number

optional

Opacity of the background behind the captions, ranging from 0 (fully hidden) to 1 (fully visible).

captionIsHidden

boolean

optional

Captions are hidden for the entire video. Use VGML for more fine-grained control.

aspectRatio

#/definitions/3055420

optional

Aspect ratio of the video.

minDimensionPixels

integer

optional

Minimum dimension of the video in pixels. Height and width will be calculated based on minDimensionPixels and aspectRatio.

<= 1080> 0

Default:

1080

{
  "script": "Machine learning is a technique where algorithms learn from data to make predictions or decisions without explicit programming... It powers applications like image recognition, natural language processing, and predictive analytics, continuously improving as it processes more data."
}

Request samples

Responses

Successfully initiated video generation(200)

Failed to initiate video generation(400)

Successfully initiated video generation

HTTP Code: 200

Content Type : JSONapplication/json

apiFileId

string

required

Primary ID of video file to be generated.

{
  "apiFileId": "874d3150-f0e3-435c-be3d-0936d892b7e7"
}

Last modified: 13 days ago