API Reference
Start typing to search…

Generate Video from Template

post
https://api.heygen.com/v2/template//generate

Generates a video based on the specified template, including scene IDs to define the sequence of scenes and variable values for replacement.

Path Params
string
required

Unique identifier of the template. Can be retrieved from the List Templates endpoint.

Body Params
boolean
Defaults to false

Whether to enable captions in the video.

string

Title of the video.

json
required

Dynamic variables used within the template.

dimension
object

Custom dimensions for the output video. Must match the aspect ratio of the template (e.g., landscape or portrait).

boolean
Defaults to false

Whether to include a GIF preview URL in the webhook response.

boolean

Whether to make the video publicly shareable immediately after creation.

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.

string

Unique identifier of the Brand Glossary. It is used to apply predefined translation and pronunciation rules such as translation exclusions, enforced terms, vocabulary mappings, and tone preferences. Can be retrieved from List Brand Voices endpoint.

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.

boolean

When true, text elements that are replaced will be vertically centered based on their actual rendered height.

Response

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago