Description

HeyGen is an AI-based, cloud-hosted platform that transforms text into professional-looking videos. It offers a vast library of realistic avatars that you can use to create your videos, making it a versatile tool for various use cases, including marketing, education, social media, and training.

HeyGen stands out with its unique features, including virtual actors that mimic human behavior, the ability to change the spoken language for different viewers, low production costs, and a user-friendly dashboard that allows you to create a video in minutes.

Supported Operations

HeyGen API

Upload Asset

Easily upload media files to enhance your AI-generated content

List Assets

List Assets

Delete Asset

Delete Asset

List Brand Voices

This endpoint is used to retrieve a list of brand voices your created

Update Brand Voice

Updates an existing brand voice with specified changes. Only the fields that need to be modified should be included in the request body.

List Folders

Retrieves a list of folders with optional filters.

Create Folder

Creates a new folder.

Update Folder (Rename Only)

Updates the name of an existing folder.

Restore Folder

Restores a folder from the trash.

Trash Folder

Moves a folder to the trash.

Create Session Token

This endpoint is used to generate a new access token for a streaming session.

Interrupt Task

This endpoint is used to interrupt the speaking of an Interactive Avatar.

Keep Alive

Resets the idle‐timeout countdown for an active streaming session.

List Sessions (Active)

This endpoint retrieves a list of currently active (open) 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.

List Streaming Avatars

This API endpoint allows you to retrieve a list of public and custom interactive avatars.

Create a Knowledge Base

Create a new knowledge base with a specified name, opening line, and custom prompt.

List Knowledge Bases

Retrieve a list of all existing knowledge bases associated with your account.

Update Knowledge Base

Update an existing knowledge base by ID.

Delete Knowledge Base

Delete a specific knowledge base by its ID.

Get Current User Information

Easily retrieve and manage your account details with a HeyGen API

Delete a Video

This endpoint allows deletion of avatar videos only. It does not support deleting translated videos.

Retrieve Video List

This endpoint retrieves a list of videos associated with the user.

Create a WebM Video

Create a WebM Video

Retrieve Sharable Video URL

Generates a public URL for a video, allowing it to be shared and accessed publicly.

Retrieve Video Status/Details

This endpoint allows you to retrieve the status and details of a specific video.

Add a Webhook Endpoint

Set up webhooks for real-time event notifications and automate your workflow

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

Retrieve Avatar Details

Retrieve detailed information about a specific avatar by its ID, including its name, gender, preview media, default voice, and tags.

List All Avatar Groups

List all avatar groups

List All Avatars in one avatar group

List all avatars in one avatar group

List All Avatars (V2)

You can get your Avatars and Talking Photos(Photo Avatars) with this endpoint.

Add motion

Add motion to an existing photo avatar, returns the id of the new avatar that has motion

Add sound effect

This api adds sound effect into a photo avatar

Add looks to photo avatar group

Add other looks to existing photo avatar group

Create photo avatar group

Easily organize and customize your AI avatars with photo groups

Check photo/look generation status

Check photo/look generation status

Generate photo avatar looks

This endpoint can be used to generate additional looks for a trained photo avatar group. The photo avatar group must be trained to use this endpoint.

Generate photo avatar photos

Effortlessly create personalized AI avatars from photos

Train photo avatar group

Train a photo avatar group.

Get training job status

Get the training status of a avatar group

Upscale an avatar

Call this api to upscale an avatar, can only be called on an avatar that has motion, returns the photo avatar id that is upscaled

Delete photo avatar

This endpoint deletes a photo avatar.

Photo avatar details

Get the details of a photo avatar

Delete photo avatar group

This endpoint deletes a photo avatar group.

List Sessions (History)

This endpoint retrieves a paginated history of all streaming sessions, including metadata such as session duration, timestamps, and other details.

Retrieve Template Details

This API now supports New AI Studio!

Generate Video from Template

This API now supports New AI Studio!

List Templates

This API now supports New AI Studio!

Get Remaining Quota

Retrieve the remaining HeyGen API quota for the authenticated user

Create Avatar IV Video

Generate an Avatar IV video from a photo with advanced AI-powered motion and expressions

Create Avatar Video (V2)

This API now generates videos with our New AI Studio backend.

Translate Video

Translate videos into 175+ languages with natural voice and perfect lip-sync

Video Translate Caption

This endpoint retrieves the video translate caption.

Generate Proofread

Generates a proofread for a video based on the specified parameters.

Generate Video from Proofread

Initiates generation of the final output from a proofread. Optional settings include adding captions or translating only the audio.

Upload SRT

Uploads an SRT file to an existing proofread using a presigned URL.

Check Proofread Status

Checks the current status of a proofread request using the provided proofread ID.

Download Proofread SRT

Returns a link to download the SRT file for the specified proofread.

List Supported Languages

List Supported Languages.

Check Translation Status

Track the progress and status of your video translations in real-time

List All Voices (V2)

List All AI Voices (V2)

List All Locales for Voices

Retrieves a list of available locales for voices, including their language, label, and locale identifiers.

Retrieve Template Details (V3)

This API supports a new field `scenes` for the New AI Studio, returning template variables mapped to scenes.

Details
Last Update

2 weeks ago

Includes
heygen-api-client
Links
HeyGen Website
HeyGen API Docs
Getting started