HeyGen API
Upload Asset
Upload Asset.
List avatars
You can use this endpoint to get a list of available avatars for generating videos.
Add Contact
This endpoint allows you to add a contact to a personalized video project.
Get Video Detail
This endpoint allows you to retrieve detailed information about a personalized video.
Get Project Detail
This endpoint allows you to retrieve detailed information about a specific personalized video project.
Create session token
This endpoint is used to generate a new access token for a streaming session.
Submit ICE information
This endpoint is used to send an ICE (Interactive Connectivity Establishment) candidate to the server.
Interrupt task
This endpoint is used to interrupt the speaking of an Interactive Avatar.
List sessions
This endpoint is used to retrieve a list of currently active streaming sessions.
New session
This endpoint is used to initiate a new streaming session.
Start session
This endpoint is used to start the connection for an existing streaming session.
Close session
This endpoint is used to terminate an active streaming session.
Send task
This endpoint is used to send a text to an Interactive Avatar, prompting it to speak the provided text.
Streaming avatar list
This API endpoint allows you to retrieve a list of public and custom interactive avatars.
Upload talking photo
Create a new talking photo.
List talking photos
List your created talking photos
(deprecated) Generate from template
Generate video from template
(deprecated) Retrieve a template
Retrieve detail of a template for generating videos
Delete a Video
This endpoint deletes an existing video.
(deprecated) Create a video
**Attention: avatars created after 03/21/2024 will no longer be supported in v1 API.**
Retrieve Video List
This endpoint retrieves a list of videos associated with the user.
Create a WebM video
Generates a webm video with transparent background and an avatar speaking the input text. You can customize the avatar's pose, style, and voice, as well as the dimensions of the video.
(deprecated) Add caption to the video
_This endpoint only works with videos generated using the v1 API._
(deprecated) Retrieve the caption video
_This endpoint only works with videos generated using the v1 API._
Retrieve a Video
This endpoint allows you to retrieve the status and details of a specific video.
List voices
List available voices in HeyGen
Add a webhook endpoint
Create a new webhook endpoint.
Delete a webhook endpoint
Delete an existing webhook endpoint.
List webhook endpoints
List all your registered webhook endpoints.
Update a webhook endpoint
Update an existing webhook endpoint.
List available webhook events
List all supported webhook events.
List Avatars V2
You can get your Avatars and Talking Photos(Photo Avatars) with this endpoint. <br/>_Note: V2 API is in beta._
Delete a talking photo V2
Delete an existing talking photo.
Get Template V2
This API now supports New AI Studio!
Generate from Template V2
This API now supports New AI Studio!
List Templates V2
This API now supports New AI Studio!
Get remaining quota V2
Get remaining quota. The returned quota would be roughly 60 * credit that showed in UI.
Create an Avatar Video V2
This API now generates videos with our New AI Studio backend.
Video Translate
Create a new video translation.
List supported languages
List supported languages for video translation.
Video Translate status
This endpoint retrieves the status of a video translation.
List Voices V2
_Note: V2 API is in beta._
