heygen-avatars

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

HeyGen Avatars

HeyGen虚拟人

AI avatar video creation using HeyGen API for talking head videos, avatar generation, and text-to-video workflows.

借助HeyGen API实现AI虚拟人视频创建，适用于说话人头视频、虚拟人生成及文本转视频工作流。

Quick Start

快速开始

typescript

// Check remaining quota
const response = await fetch("https://api.heygen.com/v2/user/remaining_quota", {
  headers: { "X-Api-Key": process.env.HEYGEN_API_KEY! }
});

// Generate avatar video
const video = await fetch("https://api.heygen.com/v2/video/generate", {
  method: "POST",
  headers: {
    "X-Api-Key": process.env.HEYGEN_API_KEY!,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    video_inputs: [{
      character: { type: "avatar", avatar_id: "your-avatar-id" },
      voice: { type: "text", input_text: "Hello world!", voice_id: "your-voice-id" }
    }],
    dimension: { width: 1280, height: 720 }
  })
});

typescript

// Check remaining quota
const response = await fetch("https://api.heygen.com/v2/user/remaining_quota", {
  headers: { "X-Api-Key": process.env.HEYGEN_API_KEY! }
});

// Generate avatar video
const video = await fetch("https://api.heygen.com/v2/video/generate", {
  method: "POST",
  headers: {
    "X-Api-Key": process.env.HEYGEN_API_KEY!,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    video_inputs: [{
      character: { type: "avatar", avatar_id: "your-avatar-id" },
      voice: { type: "text", input_text: "Hello world!", voice_id: "your-voice-id" }
    }],
    dimension: { width: 1280, height: 720 }
  })
});

When to use

适用场景

Use this skill whenever you are dealing with HeyGen API code to obtain domain-specific knowledge for creating AI avatar videos, managing avatars, handling video generation workflows, and integrating with HeyGen's services.

当你处理HeyGen API代码，需要获取创建AI虚拟人视频、管理虚拟人、处理视频生成工作流及集成HeyGen服务的领域特定知识时，可使用本技能。

How to use

使用方法

Read individual rule files for detailed explanations and code examples:

阅读单个规则文件获取详细说明及代码示例：

Foundation

基础模块

rules/authentication.md - API key setup, X-Api-Key header, and authentication patterns
rules/quota.md - Credit system, usage limits, and checking remaining quota
rules/video-status.md - Polling patterns, status types, and retrieving download URLs
rules/assets.md - Uploading images, videos, and audio for use in video generation

rules/authentication.md - API密钥设置、X-Api-Key请求头及认证模式
rules/quota.md - 信用体系、使用限制及剩余配额查询
rules/video-status.md - 轮询模式、状态类型及下载链接获取
rules/assets.md - 上传图片、视频及音频用于视频生成

Core Video Creation

核心视频创建

rules/avatars.md - Listing avatars, avatar styles, and avatar_id selection
rules/voices.md - Listing voices, locales, speed/pitch configuration
rules/scripts.md - Writing scripts, pauses/breaks, pacing, and structure templates
rules/video-generation.md - POST /v2/video/generate workflow and multi-scene videos
rules/video-agent.md - One-shot prompt video generation with Video Agent API
rules/dimensions.md - Resolution options (720p/1080p) and aspect ratios

rules/avatars.md - 虚拟人列表、虚拟人风格及avatar_id选择
rules/voices.md - 语音列表、语言区域、语速/音调配置
rules/scripts.md - 脚本编写、停顿设置、节奏把控及结构模板
rules/video-generation.md - POST /v2/video/generate工作流及多场景视频
rules/video-agent.md - 借助Video Agent API实现一键提示词视频生成
rules/dimensions.md - 分辨率选项（720p/1080p）及宽高比

Video Customization

视频定制

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

rules/backgrounds.md - 纯色、图片及视频背景
rules/text-overlays.md - 添加带字体及位置设置的文本
rules/captions.md - 自动生成字幕及字幕选项

Advanced Features

高级功能

rules/templates.md - Template listing and variable replacement
rules/video-translation.md - Translating videos, quality/fast modes, and dubbing
rules/streaming-avatars.md - Real-time interactive avatar sessions
rules/photo-avatars.md - Creating avatars from photos (talking photos)
rules/webhooks.md - Registering webhook endpoints and event types

rules/templates.md - 模板列表及变量替换
rules/video-translation.md - 视频翻译、质量/快速模式及配音
rules/streaming-avatars.md - 实时交互式虚拟人会话
rules/photo-avatars.md - 从照片创建虚拟人（说话照片）
rules/webhooks.md - 注册Webhook端点及事件类型

Integration

集成

rules/remotion-integration.md - Using HeyGen avatar videos in Remotion compositions

rules/remotion-integration.md - 在Remotion合成中使用HeyGen虚拟人视频