create_avatar_video
Generate a video of an avatar speaking a script, with your choice of avatar, voice, and background. Supports test mode for watermarked preview without credit usage.
Instructions
Create a HeyGen avatar video with specific avatar and voice selection. Use for precise control over avatar.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"script": "<script>",
"avatar_id": "<avatar_id>",
"voice_id": "<voice_id>"
},
"name": "create_avatar_video"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| script | Yes | The text the avatar will speak. Keep under 2500 characters for best results. | |
| voice_id | Yes | Voice ID from list_voices. | |
| avatar_id | Yes | Avatar ID from list_avatars. | |
| test_mode | No | If true, generates a watermarked preview without consuming credits. | |
| background | No | Background configuration: {type: 'color'|'image'|'video'|'transparent', value?: string, url?: string} | |
| aspect_ratio | No | Video aspect ratio: '16:9', '9:16', or '1:1'. | 16:9 |