> ## Documentation Index
> Fetch the complete documentation index at: https://hyperfx.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# HeyGen

> Set up and use the HeyGen integration with Hyper AI for AI avatar videos, voice cloning, and video translation

The HeyGen integration lets your agents generate AI avatar videos, run text-to-speech with cloned voices, translate videos into other languages, and produce lipsync videos.

Auth type: API key

<Info>
  For how integrations work overall (permissions, authentication, troubleshooting), see the main guide: [App Integrations](/integrations/overview).
</Info>

## Connect HeyGen

1. Go to **Settings → Apps** in Hyper
2. Select **HeyGen → Connect New**
3. Paste your HeyGen API key

### Where to find your HeyGen API key

1. Sign in to [HeyGen](https://app.heygen.com)
2. Go to **Settings → API**
3. Generate an API key with the scopes you need (avatar video, translation, lipsync)
4. Copy the key and paste it into Hyper

## Common capabilities

* **Avatar videos** — list avatars and avatar groups, look up specific looks, create avatar videos from a script
* **Voices and TTS** — list voices, generate audio from text
* **Video translation** — translate an existing video into another language with the speaker's voice
* **Lipsync** — sync a face to new audio
* **Asset management** — upload assets, list/get/delete videos
* **Polling helpers** — async-aware tools that wait for renders to complete

## Use in Chat

1. In a chat, open the tool selector and enable HeyGen
2. Ask your agent to produce a video

Example prompt:

```text theme={null}
Generate a 30-second HeyGen avatar video using my "Brand Spokesperson" avatar. Script: "Q4 was our best quarter ever — here's what happened and what's next." Use the "Marketing Voice" voice. Send the rendered video to the #marketing Slack channel when it's done.
```

## Use in Agents

In `Agents → Settings`, add HeyGen to a content-production agent alongside [Google Veo](/integrations/google-veo), [OpenAI Sora](/integrations/openai-sora), or image generation. Common pattern: an agent drafts the script → generates the avatar video → posts to social.

## Use in Flows

Add HeyGen nodes to automated content pipelines. Common pattern: scheduled trigger → write script via LLM → render avatar video → publish to TikTok / Instagram Reels.

## Troubleshooting

* **Render timed out**: video translation and large avatar renders can take several minutes — use polling to wait gracefully
* **Avatar not found**: list avatars first to confirm the avatar ID belongs to your account
* **Quota exceeded**: HeyGen enforces credits per plan — upgrade or wait for the next billing cycle

***

## Available Actions

Hyper agents can run the following actions for this integration. Each action can be individually set to **Enabled**, **Requires Approval**, or **Disabled** in your agent's toolkit settings.

Actions can be set to one of three control states:

| State                 | Behavior                                                       |
| --------------------- | -------------------------------------------------------------- |
| **Enabled**           | Agent runs the action automatically                            |
| **Requires Approval** | Agent pauses and waits for your confirmation before proceeding |
| **Disabled**          | Action is blocked and cannot be used                           |

Configure these in the agent's toolkit settings or in workspace defaults.

| Action                     | Description                                                                                                              |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Create Avatar Video        |                                                                                                                          |
| Create Lipsync             |                                                                                                                          |
| Create Video Translation   |                                                                                                                          |
| Delete Lipsync             | Delete a lipsync job by id (V3)                                                                                          |
| Delete Video               | Delete a video by video\_id (V2)                                                                                         |
| Get Avatar Group           | Get a single HeyGen avatar group by group\_id (V3)                                                                       |
| Get Lipsync                | Get a lipsync job by id (V3 /v3/lipsyncs/{id})                                                                           |
| Get User Me                | Return the authenticated HeyGen user account info (plan, remaining credits, etc.)                                        |
| Get Video                  | Get details for a single video by video\_id (V2)                                                                         |
| Get Video Translation      | Get a video translation job by id (V3 /v3/video-translations/{id})                                                       |
| List Audio Voices          | List HeyGen audio (text-to-speech) voices via V1 endpoint                                                                |
| List Avatar Looks          | List avatar looks across groups (V3). Optional `query` for filtering                                                     |
| List Avatars               | List HeyGen avatar groups (V3). Optional `query` for pagination/filtering                                                |
| List Lipsyncs              | List lipsync jobs (V3). Optional `query` for pagination/filtering                                                        |
| List Translation Languages | List supported video translation languages (V3)                                                                          |
| List Video Translations    | List video translation jobs (V3). Optional `query` for pagination/filtering                                              |
| List Videos                | List videos for the account (V2 /v2/videos). Optional `query` for pagination                                             |
| List Voices                | List HeyGen voices (V3). Optional query params (page\_size, language, gender, voice\_id, etc.) may be passed via `query` |
| Poll Lipsync               |                                                                                                                          |
| Poll Video                 |                                                                                                                          |
| Poll Video Translation     |                                                                                                                          |
| Text To Speech             |                                                                                                                          |
| Upload Asset               |                                                                                                                          |