post https://api.heygen.com/v1/template.generate
Generate video from template
This API is deprecated and will be removed in 6 months. Please migrate to List Templates V2 and Template Generation V2 . Finetuned and Studio Avatars created after 03/21/2024 will no longer be supported in v1 API.
Request Body
| Field | Type | Description |
|---|---|---|
| template_id | string | Unique identifier for the template video. |
| test | bool | Set the test flag to true to use test mode. Generation in test mode will not cost your credits and will contain a watermark on your video. |
| title | string | Optional, Your video title. |
| caption_open | bool | Set it true to create video with caption. |
| variables | List of variables you want to replace. | |
| variables[].name | string | The name of the variables. |
| variables[].properties | Object | Properties of the variables you want to replace. |
Response
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the object. |
| error | json | Optional, the error detail of the video. |
| status | string | Video status, one of - processing (The video is rendering)- completed (The video render success)- failed (An error occurred when rendering video). |
Tools
You may use this web tool to find out the variable name for your video template.