# HeyGen integration

> Generate AI avatar videos, translate videos, manage voices/templates/assets, and run interactive streaming avatars via the HeyGen API.

- Authentication: apiKey

## Tools (67)

- **Add Contact to Personalized Video Project**: Add a contact (recipient) to an existing personalized video project for bulk rendering.
- **Add Looks to Photo Avatar Group**: Add additional photo "looks" (outfits, poses) to an existing photo avatar group.
- **Add Motion to Photo Avatar**: Animate a still photo-avatar look — required before you can upscale it.
- **Add Webhook Endpoint**: Register a webhook URL to receive event notifications (e.g. avatar_video.success).
- **Check Photo / Look Generation Status**: Poll the status of a photo-avatar photo or look generation job by ID.
- **Check Video Translate Status**: Poll the status of a video translation job by ID.
- **Create Folder**: Create a new folder to organise videos and assets.
- **Create Knowledge Base**: Create a knowledge base (opening line + prompt) used by Interactive Avatars.
- **Create Photo Avatar Group**: Create a new photo avatar group from one or more reference photos. First step in training a custom photo avatar.
- **Create Streaming Session**: Create a new Interactive Avatar streaming session. Returns SDP, ICE servers, and session ID.
- **Create Streaming Session Token**: Mint a short-lived access token for an Interactive Avatar streaming session (used by client SDKs).
- **Create WebM Video**: Generate a video in WebM format (e.g. with transparency) instead of the default MP4.
- **Delete Asset**: Delete a single uploaded asset by ID.
- **Delete Knowledge Base**: Delete a knowledge base by ID.
- **Delete Photo Avatar**: Delete a single photo avatar / look by ID.
- **Delete Photo Avatar Group**: Delete an entire photo avatar group and all of its looks.
- **Delete Talking Photo**: Delete a Talking Photo by ID.
- **Delete Video**: Permanently delete a generated or translated video by ID.
- **Delete Webhook Endpoint**: Delete a registered webhook endpoint.
- **Generate Avatar Video**: Create an AI avatar video from one or more scenes (avatar + voice + background). Returns a video_id to poll.
- **Generate Photo Avatar Photos**: Generate AI photo-avatar images from a text prompt with attributes (age, gender, pose, style).
- **Generate Text-to-Speech**: Generate a standalone audio file from text using a HeyGen voice (no avatar / video).
- **Generate Video from Template**: Render a video by filling a template's variables with values. Returns a video_id to poll.
- **Generate Voice Audio Preview**: Generate a short audio preview for a given voice and script (used to audition voices).
- **Get Current User Information**: Retrieve the authenticated user's account profile.
- **Get Personalized Video Project Detail**: Fetch the detail of a personalized video project, including contact list and render status.
- **Get Photo Avatar Details**: Retrieve the details (status, image URL, group) of a single photo avatar by ID.
- **Get Remaining Quota**: Get the remaining API credits / quota for the authenticated user.
- **Get Training Job Status**: Check the photo-avatar training status for an avatar group.
- **Interrupt Streaming Session**: Interrupt the avatar's current speech in a streaming session.
- **Keep Streaming Session Alive**: Send a keep-alive ping to prevent an idle streaming session from timing out.
- **List Assets**: Paginated list of uploaded assets (images, audio, video) filterable by type and folder.
- **List Available Webhook Events**: List the event types you can subscribe a webhook to.
- **List Avatar Groups**: List all avatar groups (collections of looks for the same subject).
- **List Avatars**: List all avatars (stock and custom) available to your account.
- **List Avatars in Group**: List the individual looks/avatars inside a specific avatar group.
- **List Brand Voices**: List Brand Voice glossaries you have created (pronunciation/terminology rules).
- **List Folders**: List folders in the account, used to organise videos and assets.
- **List Knowledge Bases**: List knowledge bases used by Interactive (streaming) Avatars.
- **List Streaming Avatars**: List avatars available for the Interactive Streaming Avatar API.
- **List Streaming Session History**: List historical streaming sessions (active and ended).
- **List Streaming Sessions**: List currently active streaming sessions on the account.
- **List Talking Photos**: List all Talking Photo (photo avatar) assets in your account.
- **List Templates**: List all user-created video templates available for template-based generation.
- **List Videos**: Paginated list of all videos in the account, including generated and translated videos.
- **List Video Translate Target Languages**: List the languages supported as translation targets.
- **List Voice Locales**: List the accent/locale codes (e.g. en-US, en-IN) supported for multilingual voices.
- **List Voices**: List all TTS voices available in your account.
- **List Webhook Endpoints**: List all registered webhook endpoints on the account.
- **Restore Folder**: Restore a previously trashed folder back to its original location.
- **Retrieve Avatar Details**: Get detailed info (preview URLs, status, group) for a single avatar by ID.
- **Retrieve Shareable Video URL**: Generate a public share link (https://app.heygen.com/share/...) for a finished video.
- **Retrieve Template Details**: Get the variable definitions and scenes of a template.
- **Retrieve Video Status / Details**: Poll the status and download URLs of a video by ID. Returned URLs expire after 7 days.
- **Search Public Avatar Groups**: Search HeyGen's public catalogue of stock avatar groups by keyword.
- **Send Task to Streaming Avatar**: Make a streaming avatar speak the given text in real time.
- **Start Streaming Session**: Confirm a streaming session is ready (after sending SDP answer back).
- **Stop Streaming Session**: End an Interactive Avatar streaming session.
- **Submit Streaming ICE Candidates**: Post ICE candidates for WebRTC connection setup on a streaming session.
- **Translate Video**: Submit a video URL for AI translation into one or more of 175+ languages with lip-sync.
- **Trash Folder**: Move a folder to the trash. Folder can be restored later with Restore Folder.
- **Update Folder**: Rename a folder by ID.
- **Update Knowledge Base**: Update an existing knowledge base by ID.
- **Update Webhook Endpoint**: Update a webhook's URL or subscribed events.
- **Upload Asset**: Upload an image, video, or audio file as raw binary. Returns an asset ID/URL for use in video generation.
- **Upload Talking Photo (Binary)**: Upload a photo as raw binary to create a new Talking Photo asset.
- **Upscale Avatar**: Upscale a motion-enabled photo-avatar look to higher resolution.

## Related prompts

- [Welcome new BambooHR hires with an AI video in Slack](https://www.generalinput.com/prompts/welcome-new-bamboohr-hires-with-an-ai-video-in-slack.md)
- [Personalized AI welcome video for every new HubSpot lead](https://www.generalinput.com/prompts/personalized-ai-welcome-video-for-every-new-hubspot-lead.md)
- [Personalized HeyGen welcome video for every Calendly booking](https://www.generalinput.com/prompts/personalized-heygen-welcome-video-for-every-calendly-booking.md)
- [Pre-call AI intro videos for Calendly bookings, with HubSpot context](https://www.generalinput.com/prompts/pre-call-ai-intro-videos-for-calendly-bookings-with-hubspot-context.md)
- [Auto translate new YouTube uploads into 5 languages every Monday](https://www.generalinput.com/prompts/auto-translate-new-youtube-uploads-into-5-languages-every-monday.md)

Connect HeyGen in General Input: https://www.generalinput.com/apps/heygen