API Reference

Quick Reference

Task	Reference Files
Generate video from prompt (easy)	`prompt-optimizer.md` → `video-agent.md`
Generate video with precise control	`video-generation.md`, `avatars.md`, `voices.md`
Check video status / get download URL	`video-status.md`
Add captions or text overlays	`captions.md`, `text-overlays.md`
Transparent video for compositing	`video-generation.md` (WebM section)
Real-time interactive avatar	`streaming-avatars.md`
Translate/dub existing video	`video-translation.md`
Use with Remotion	`remotion-integration.md`

API Overview

Base URL: https://api.heygen.com
Authentication: X-Api-Key header
API Versions: v1, v2 (varies by endpoint)

Key Endpoints

Endpoint	Purpose
`POST /v1/video_agent/generate`	One-shot prompt-to-video (Video Agent)
`POST /v2/video/generate`	Precise multi-scene video generation
`GET /v1/video_status.get`	Check video generation status
`GET /v2/avatars`	List available avatars
`GET /v2/voices`	List available voices

Skill Contents

Foundation

File	Description
`authentication.md`	API key setup and X-Api-Key header
`quota.md`	Credit system and usage limits
`video-status.md`	Polling patterns and download URLs
`assets.md`	Uploading images, videos, audio

Core Video Creation

File	Description
`avatars.md`	Listing avatars, styles, avatar_id selection
`voices.md`	Voice configuration, locales, speed/pitch
`scripts.md`	Writing scripts, pauses, pacing
`video-generation.md`	Video creation workflow (v2 API)
`video-agent.md`	One-shot prompt-to-video generation
`prompt-optimizer.md`	Writing effective Video Agent prompts (scene-by-scene structure, timing, visual styles)
`dimensions.md`	Resolution and aspect ratios

Video Customization

File	Description
`backgrounds.md`	Solid colors, images, and video backgrounds
`text-overlays.md`	Adding text with fonts and positioning
`captions.md`	Auto-generated captions and subtitles

Advanced Features

File	Description
`templates.md`	Template-based video generation
`video-translation.md`	Translation and dubbing
`streaming-avatars.md`	Real-time interactive avatars
`photo-avatars.md`	Photo-based avatar creation
`webhooks.md`	Event notifications

Integration

File	Description
`remotion-integration.md`	Using HeyGen in Remotion compositions

Updated 3 days ago