Avatar Video

Create AI avatar videos with full control over avatars, voices, scripts, scenes, and backgrounds. Build single or multi-scene videos with exact configuration using HeyGen's /v2/video/generate API.

Authentication

All requests require the X-Api-Key header. Set the HEYGENAPIKEY environment variable.

curl -X GET "https://api.heygen.com/v2/avatars" \
  -H "X-Api-Key: $HEYGEN_API_KEY"

Tool Selection

If HeyGen MCP tools are available (mcpheygen*), prefer them over direct HTTP API calls — they handle authentication and request formatting automatically.

Video generation (POST /v2/video/generate) and avatar/voice listing are done via direct API calls — see reference files below.

Default Workflow

1. List avatars — GET /v2/avatars → pick an avatar, preview it, note avatarid and defaultvoice_id. See [avatars.md](references/avatars.md)
2. List voices (if needed) — GET /v2/voices → pick a voice matching the avatar's gender/language. See [voices.md](references/voices.md)
3. Write the script — Structure scenes with one concept each. See [scripts.md](references/scripts.md)
4. Generate the video — POST /v2/video/generate with avatar, voice, script, and background per scene. See [video-generation.md](references/video-generation.md)
5. Poll for completion — GET /v2/videos/{video_id} until status is completed. See [video-status.md](references/video-status.md)

Quick Reference

When to Use This Skill vs Create Video

This skill is for precise control — you choose the avatar, write the exact script, configure each scene.

If the user just wants to describe a video idea and let AI handle the rest (script, avatar, visuals), use the create-video skill instead.

Reference Files

Core Video Creation

• [references/avatars.md](references/avatars.md) - Listing avatars, styles, avatar_id selection
• [references/voices.md](references/voices.md) - Listing voices, locales, speed/pitch
• [references/scripts.md](references/scripts.md) - Writing scripts, pauses, pacing
• [references/video-generation.md](references/video-generation.md) - POST /v2/video/generate and multi-scene videos

Video Customization

• [references/backgrounds.md](references/backgrounds.md) - Solid colors, images, video backgrounds
• [references/text-overlays.md](references/text-overlays.md) - Adding text with fonts and positioning
• [references/captions.md](references/captions.md) - Auto-generated captions and subtitles

Advanced Features

• [references/templates.md](references/templates.md) - Template listing and variable replacement
• [references/photo-avatars.md](references/photo-avatars.md) - Creating avatars from photos
• [references/webhooks.md](references/webhooks.md) - Webhook endpoints and events

Integration

• [references/remotion-integration.md](references/remotion-integration.md) - Using HeyGen in Remotion compositions

Foundation

• [references/video-status.md](references/video-status.md) - Polling patterns and download URLs
• [references/assets.md](references/assets.md) - Uploading images, videos, audio
• [references/dimensions.md](references/dimensions.md) - Resolution and aspect ratios
• [references/quota.md](references/quota.md) - Credit system and usage limits

Best Practices

1. Preview avatars before generating — Download previewimageurl so the user can see the avatar before committing
2. Use avatar's default voice — Most avatars have a defaultvoiceid pre-matched for natural results
3. Fallback: match gender manually — If no default voice, ensure avatar and voice genders match
4. Use test mode for development — Set test: true to avoid consuming credits (output will be watermarked)
5. Set generous timeouts — Video generation often takes 5-15 minutes, sometimes longer
6. Validate inputs — Check avatar and voice IDs exist before generating