Back to Details

heygen

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

HeyGen API

HeyGen API

AI avatar video creation API for generating talking-head videos, explainers, and presentations.

用于生成对话式视频、讲解视频和演示视频的AI数字人视频创作API。

Default Workflow

默认工作流程

Prefer Video Agent API (

POST /v1/video_agent/generate

) for most video requests. Always use prompt-optimizer.md guidelines to structure prompts with scenes, timing, and visual styles.

Only use v2/video/generate when user explicitly needs:

Exact script without AI modification
Specific voice_id selection
Different avatars/backgrounds per scene
Precise per-scene timing control
Programmatic/batch generation with exact specs

大多数视频请求优先使用Video Agent API（

POST /v1/video_agent/generate

）。请始终遵循prompt-optimizer.md中的指南，构建包含场景、时长和视觉风格的提示词。

仅当用户明确需要以下功能时，才使用v2/video/generate接口：

无需AI修改的精确脚本
特定voice_id选择
每个场景使用不同的数字人/背景
精确的逐场景时长控制
符合精确规格的程序化/批量生成

Quick Reference

快速参考

Task	Read
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

任务	参考文档
从提示词生成视频（简易版）	prompt-optimizer.md → video-agent.md
精确控制生成视频	video-generation.md, avatars.md, voices.md
查看视频状态 / 获取下载链接	video-status.md
添加字幕或文本叠加层	captions.md, text-overlays.md
创建用于合成的透明视频	video-generation.md（WebM章节）
实时交互式数字人	streaming-avatars.md
翻译/配音现有视频	video-translation.md
与Remotion集成使用	remotion-integration.md

Reference Files

参考文档

Foundation

基础部分

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

references/authentication.md - API密钥设置与X-Api-Key请求头
references/quota.md - 信用体系与使用限制
references/video-status.md - 查询模式与下载链接
references/assets.md - 图片、视频、音频上传

Core Video Creation

核心视频创作

references/avatars.md - Listing avatars, styles, avatar_id selection
references/voices.md - Listing voices, locales, speed/pitch
references/scripts.md - Writing scripts, pauses, pacing
references/video-generation.md - POST /v2/video/generate and multi-scene videos
references/video-agent.md - One-shot prompt video generation
references/prompt-optimizer.md - Writing effective Video Agent prompts
references/dimensions.md - Resolution and aspect ratios

references/avatars.md - 数字人列表、风格及avatar_id选择
references/voices.md - 语音列表、语言区域、语速/音调
references/scripts.md - 脚本编写、停顿、节奏控制
references/video-generation.md - POST /v2/video/generate接口与多场景视频
references/video-agent.md - 一键式提示词视频生成
references/prompt-optimizer.md - 编写高效的Video Agent提示词
references/dimensions.md - 分辨率与宽高比

Video Customization

视频定制

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

references/backgrounds.md - 纯色、图片、视频背景
references/text-overlays.md - 添加带字体与位置设置的文本
references/captions.md - 自动生成字幕与副标题

Advanced Features

高级功能

references/templates.md - Template listing and variable replacement
references/video-translation.md - Translating videos and dubbing
references/streaming-avatars.md - Real-time interactive sessions
references/photo-avatars.md - Creating avatars from photos
references/webhooks.md - Webhook endpoints and events

references/templates.md - 模板列表与变量替换
references/video-translation.md - 视频翻译与配音
references/streaming-avatars.md - 实时交互式会话
references/photo-avatars.md - 从照片创建数字人
references/webhooks.md - Webhook端点与事件

Integration

集成部分

references/remotion-integration.md - Using HeyGen in Remotion compositions

references/remotion-integration.md - 在Remotion合成中使用HeyGen