HeyGen API Documentation (Complete)
Generated: 2025-09-18 10:56:32
Table of Contents
- Quick Start
- Create Avatar Videos
- Customize Video Background
- Using Audio Source as Voice
- Generate Video from Template
- Video Translate API
- Photo Avatars API
- Streaming API Overview
- Streaming Avatar SDK
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
- Bulk Video Translation
- HeyGen OAuth
- HeyGen MCP Server
Quick Start
Source: https://docs.heygen.com/docs/quick-start Generated: 2025-09-18 10:55:57
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Create Avatar Videos
Source: https://docs.heygen.com/docs/create-video Generated: 2025-09-18 10:55:58
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Customize Video Background
Source: https://docs.heygen.com/docs/customize-video-background Generated: 2025-09-18 10:55:59
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Using Audio Source as Voice
Source: https://docs.heygen.com/docs/using-audio-source-as-voice Generated: 2025-09-18 10:56:00
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Generate Video from Template
Source: https://docs.heygen.com/docs/generate-video-from-template-v2 Generated: 2025-09-18 10:56:08
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Video Translate API
Source: https://docs.heygen.com/docs/video-translate Generated: 2025-09-18 10:56:11
Overview
Avatars and Voices
- List All Avatars (V2)get
- List All Voices (V2)get
- List All Locales for Voicesget
- List All Avatar Groupsget
- List All Avatars in one avatar groupget
- Retrieve Avatar Detailsget
Video Generation
- Create Avatar Video (V2)post
- Retrieve Video Status/Detailsget
- Delete a Videodel
- Create a WebM Videopost
- Create Avatar IV Videopost
Video Management
templates
video translation
- List Supported Languagesget
- Translate Videopost
- Check Translation Statusget
- Video Translate Captionget
- Generate Proofreadpost
- Check Proofread Statusget
- Download Proofread SRTget
- Upload SRTpost
- Generate Video from Proofreadpost
STREAMING API
- New Sessionpost
- Start Sessionpost
- List Sessions (Active)get
- List Sessions (History)get
- Send Taskpost
- Close Sessionpost
- Interrupt Taskpost
- Create Session Tokenpost
- List Streaming Avatarsget
- Keep Alivepost
- WSS Audio to Video API (Beta)
Streaming API Knowledge Base
- List Knowledge Basesget
- Create a Knowledge Basepost
- Update Knowledge Basepost
- Delete Knowledge Basepost
PHOTO AVATARS
- Generate photo avatar photospost
- Check photo/look generation statusget
- Create photo avatar grouppost
- Add looks to photo avatar grouppost
- Train photo avatar grouppost
- Get training job statusget
- Generate photo avatar lookspost
- Add motionpost
- Add sound effectpost
- Photo avatar detailsget
- Upscale an avatarpost
- Delete photo avatardel
- Delete photo avatar groupdel
Brand
User
Assets
WEBHOOK
- List Webhook Endpointsget
- Add a Webhook Endpointpost
- Update a Webhook Endpointpatch
- Delete a Webhook Endpointdel
- List Available Webhook Eventsget
Folders
- List Foldersget
- Create Folderpost
- Update Folder (Rename Only)post
- Trash Folderpost
- Restore Folderpost
Photo Avatars API
Source: https://docs.heygen.com/docs/photo-avatars-api Generated: 2025-09-18 10:56:13
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Streaming API Overview
Source: https://docs.heygen.com/docs/streaming-api Generated: 2025-09-18 10:56:14
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Streaming Avatar SDK
Source: https://docs.heygen.com/docs/streaming-avatar-sdk Generated: 2025-09-18 10:56:15
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Firewall Configuration
Source: https://docs.heygen.com/docs/firewall-configuration Generated: 2025-09-18 10:56:22
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Interactive Avatar API - Avatar Version Deprecation Notice
Source: https://docs.heygen.com/docs/interactive-avatar-api-avatar-version-deprecation-notice Generated: 2025-09-18 10:56:23
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
Bulk Video Translation
Source: https://docs.heygen.com/docs/bulk-video-translation Generated: 2025-09-18 10:56:29
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
HeyGen OAuth
Source: https://docs.heygen.com/docs/heygen-oauth Generated: 2025-09-18 10:56:30
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation
Other guides
HeyGen MCP Server
Source: https://docs.heygen.com/docs/heygen-mcp-server Generated: 2025-09-18 10:56:31
Getting Started
Generate and translate videos
- Create Avatar Videos __
- Generate Video from Template __
- HeyGen's Webhook Events __
- Video Translate API
- Photo Avatars API __
streaming with interactive avatars
- Streaming API Overview __
- Streaming Avatar SDK __
- Demo: Create a Vite Project with Streaming SDK __
- Demo: Create an iOS App featuring Interactive Avatar
- Firewall Configuration
- Interactive Avatar API - Avatar Version Deprecation Notice
Automate with HeyGen API
- Zapier Integration __
- Personalized Video __
- Create personalized video template
- Generate personalized videos from template via Google Sheets + Zapier
- Generate personalized videos from template via API __
- Deliver personalized videos via mail merge with Gmail
- Deliver personalized videos via HubSpot email
- Automatically generate and deliver personalized videos via HubSpot + Zapier
- Upcoming changes to personalized video (Jan, 2025)
- Sending Personalized Videos with the HeyGen HubSpot app
- Bulk Video Translation