get https://api.heygen.com/v3/template/
This API supports a new field scenes for the New AI Studio, returning template variables mapped to scenes.
Response
| Field | Type | Description |
|---|---|---|
| scenes | List of scenes in order. null for V3 drafts. | |
| scenes[].id | string | Element id for the scene. |
| scenes[].script | string | Text contained in scene. |
| scenes[].variables | Variables available for replacement in scene. | |
| scenes[].variables[].name | string | Variable name set by user. |
| scenes[].variables[].type | string | Type of variable. |
| scenes | ||
| version | string | Draft version (e.g. "3", "4"). |
| variables | Variables available for replacement. | |
| variables.<name> | Variable object. | |
| variables.<name>.name | string | Variable name set by user. |
| variables.<name>.type | string | Type of variable. |
| variables.<name>.properties | Properties object. | |
| variables.<name>.properties.content | string | Default content for text variable. |
| variables.<name>.properties.url | string | Default url for image/video/audio variable. |
| variables.<name>.properties.asset_id | string | Default asset_id for image/video/audio variable. |
| variables.<name>.properties.fit | string | Default fit for image/video variable. |
| variables.<name>.properties.play_style | string | Default play_style for video variable. |
| variables.<name>.properties.character_id | string | Default character_id for character variable. |
| variables.<name>.properties.type | string | Type of character for character variable. |
| variables.<name>.properties.voice_id | string | Default voice_id for text variable. |