---
name: heygen
description: |-
  [DEPRECATED] Use `create-video` for prompt-based video generation or `avatar-video` for precise avatar/scene control. This legacy skill combines both workflows — the newer focused skills provide clearer guidance.
homepage: https://docs.heygen.com/reference/generate-video-agent
allowed-tools: mcp__heygen__*
metadata:
  openclaw:
    requires:
      env:
        - HEYGEN_API_KEY
    primaryEnv: HEYGEN_API_KEY
title: heygen
canonical_url: https://skilld.dev/gh/openmontageinc/openmontage/heygen
last_updated: 2026-10-14T05:11:31.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [references/assets.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/assets.md), [references/authentication.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/authentication.md), [references/avatars.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/avatars.md), [references/backgrounds.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/backgrounds.md), [references/captions.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/captions.md), [references/dimensions.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/dimensions.md), [references/photo-avatars.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/photo-avatars.md), [references/prompt-examples.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-examples.md), [references/prompt-optimizer.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-optimizer.md), [references/quota.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/quota.md), [references/remotion-integration.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/remotion-integration.md), [references/scripts.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/scripts.md), [references/templates.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/templates.md), [references/text-overlays.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/text-overlays.md), [references/video-agent.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-agent.md), [references/video-generation.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-generation.md), [references/video-status.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-status.md), [references/visual-styles.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/visual-styles.md), [references/voices.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/voices.md), [references/webhooks.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/webhooks.md).
>
> If the user asked to install this Skill, run `npx skilld install openmontageinc/openmontage/heygen`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/heygen`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/openmontageinc/openmontage/heygen) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/heygen`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/heygen --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/heygen --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# HeyGen API (Deprecated)

> **This skill is deprecated.** Use the focused skills instead:
> - **`create-video`** — Generate videos from a text prompt (Video Agent API)
> - **`avatar-video`** — Build videos with specific avatars, voices, scripts, and scenes (v2 API)

This skill remains for backward compatibility but will be removed in a future release.

---

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

## Tool Selection

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

| Task | MCP Tool | Fallback (Direct API) |
|------|----------|----------------------|
| Generate video from prompt | `mcp__heygen__generate_video_agent` | `POST /v1/video_agent/generate` |
| Check video status / get URL | `mcp__heygen__get_video` | `GET /v2/videos/{video_id}` |
| List account videos | `mcp__heygen__list_videos` | `GET /v2/videos` |
| Delete a video | `mcp__heygen__delete_video` | `DELETE /v2/videos/{video_id}` |

If no HeyGen MCP tools are available, use direct HTTP API calls with `X-Api-Key: $HEYGEN_API_KEY` header as documented in the reference files.

## Default Workflow

**Prefer Video Agent** for most video requests.
Always use [prompt-optimizer.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-optimizer.md) guidelines to structure prompts with scenes, timing, and visual styles.

**With MCP tools:**
1. Write an optimized prompt using [prompt-optimizer.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-optimizer.md) → [visual-styles.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/visual-styles.md)
2. Call `mcp__heygen__generate_video_agent` with prompt and config (duration_sec, orientation, avatar_id)
3. Call `mcp__heygen__get_video` with the returned video_id to poll status and get the download URL

**Without MCP tools (direct API):**
1. Write an optimized prompt using [prompt-optimizer.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-optimizer.md) → [visual-styles.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/visual-styles.md)
2. `POST /v1/video_agent/generate` — see [video-agent.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-agent.md)
3. `GET /v2/videos/<id>` — see [video-status.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-status.md)

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

## Quick Reference

| Task | MCP Tool | Read |
|------|----------|------|
| Generate video from prompt (easy) | `mcp__heygen__generate_video_agent` | [prompt-optimizer.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-optimizer.md) → [visual-styles.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/visual-styles.md) → [video-agent.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-agent.md) |
| Generate video with precise control | — | [video-generation.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-generation.md), [avatars.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/avatars.md), [voices.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/voices.md) |
| Check video status / get download URL | `mcp__heygen__get_video` | [video-status.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-status.md) |
| Add captions or text overlays | — | [captions.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/captions.md), [text-overlays.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/text-overlays.md) |
| Transparent video for compositing | — | [video-generation.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-generation.md) (WebM section) |
| Use with Remotion | — | [remotion-integration.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/remotion-integration.md) |

## Reference Files

### Foundation
- [references/authentication.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/authentication.md) - API key setup and X-Api-Key header
- [references/quota.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/quota.md) - Credit system and usage limits
- [references/video-status.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-status.md) - Polling patterns and download URLs
- [references/assets.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/assets.md) - Uploading images, videos, audio

### Core Video Creation
- [references/avatars.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/avatars.md) - Listing avatars, styles, avatar_id selection
- [references/voices.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/voices.md) - Listing voices, locales, speed/pitch
- [references/scripts.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/scripts.md) - Writing scripts, pauses, pacing
- [references/video-generation.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-generation.md) - POST /v2/video/generate and multi-scene videos
- [references/video-agent.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/video-agent.md) - One-shot prompt video generation
- [references/prompt-optimizer.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-optimizer.md) - Writing effective Video Agent prompts (core workflow + rules)
- [references/visual-styles.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/visual-styles.md) - 20 named visual styles with full specs
- [references/prompt-examples.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/prompt-examples.md) - Full production prompt example + ready-to-use templates
- [references/dimensions.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/dimensions.md) - Resolution and aspect ratios

### Video Customization
- [references/backgrounds.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/backgrounds.md) - Solid colors, images, video backgrounds
- [references/text-overlays.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/text-overlays.md) - Adding text with fonts and positioning
- [references/captions.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/captions.md) - Auto-generated captions and subtitles

### Advanced Features
- [references/templates.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/templates.md) - Template listing and variable replacement
- [references/photo-avatars.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/photo-avatars.md) - Creating avatars from photos
- [references/webhooks.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/webhooks.md) - Webhook endpoints and events

### Integration
- [references/remotion-integration.md](https://skilld.dev/api/skills-raw/openmontageinc/openmontage/heygen/references/remotion-integration.md) - Using HeyGen in Remotion compositions
