Generate Studio Video

post

https://api.heygen.com/v2/video/generate

Generates videos using the AI Studio backend with support for avatars, voices, and dynamic backgrounds. You can create videos using either your photo avatar or digital twin. This endpoint supports Avatar III and Avatar IV.

Body Params

caption

boolean

Defaults to false

Whether to enable captions in the video. Only supported for text-based input.

title

string

Title of this video

callback_id

string

Custom ID for callback purposes. Returned in the status/webhook payload for tracking.

video_inputs

array of objects

required

Array of video input settings (scenes). Must contain between 1 to 50 items. A video input describes the avatar, background, voice, and script, which together equals a 'scene'.

video_inputs*

dimension

object

Custom dimensions for the output video.

folder_id

string

Unique identifier of the folder where the video is stored. Can be retrieved from the List Folders endpoint if folder already exists, or from the response of the Create Folder endpoint after creating a new folder.

callback_url

string

URL to notify when video rendering is complete, useful when your callback endpoint is dynamic and each video requires a separate callback. Using a webhook endpoint is still the recommended approach, as it provides more customization options such as secrets, event filtering, and more. If both webhook and callback_url are used, events will be sent to both endpoints.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Video creation initiated successfully - Expand to view the detailed response schema.

400Invalid parameters:circle_background_color must be in hex format.Either url or image_asset_id needs to be provided.Either audio_url or audio_asset_id needs to be provided.