Reference

Add contact to personalized video project

This endpoint allows you to add one or more contacts to a specific personalized video project in the Heygen platform.

Add looks to photo avatar group

Tool to add additional looks (images) to an existing photo avatar group.

Add motion to photo avatar

Tool to add natural motion or animation to an existing photo avatar, turning a still image into a moving, lifelike one.

Add webhook endpoint

Adds a new webhook endpoint to receive real-time notifications for specified Heygen events.

Check photo/look generation status

Tool to retrieve the current status and details of a photo avatar or look generation by its ID.

Create a new folder

Tool to create a new folder under your HeyGen account.

Create knowledge base

Tool to create a new knowledge base with a specified name, opening line, and custom prompt for Interactive Avatar streaming sessions.

Create new streaming session

Tool to initiate a new streaming session with an Interactive Avatar for real-time interactions.

Create photo avatar group

Tool to create an avatar group which can include both AI-generated and user-uploaded photos of the avatar.

Create streaming token with expiry

Creates a new streaming token for use with HeyGen's real-time avatar and voice chat services.

Create WebM video

Tool to create a WebM format video with transparent background featuring an avatar speaking text or audio.

Delete an avatar video

Tool to delete a video by its ID from HeyGen account.

Delete asset

Tool to delete a specific asset by its unique asset ID from HeyGen account.

Delete knowledge base

Tool to delete a specific knowledge base by its ID.

Delete photo avatar

Tool to delete a photo avatar by its ID from HeyGen account.

Delete photo avatar group

Tool to delete a photo avatar group by its ID from HeyGen account.

Delete talking photo by id

Deletes a specific talking photo from the HeyGen platform using its unique identifier.

Delete webhook endpoint

Tool to permanently delete a webhook endpoint from HeyGen.

Fetch personalized video project detail

Retrieves detailed information about a specific personalized video project in HeyGen, including status, settings, and metadata.

Generate photo avatar photos

Tool to generate a personalized AI avatar based on text prompts and attribute inputs.

Generate text-to-speech audio

Tool to generate a speech audio file from any text input using a specified voice, powered by HeyGen's Starfish model.

Generate video template with variables

Generates a customized video from a pre-existing template using HeyGen's AI platform.

Generate video with inputs

Generates a customized video using Heygen's AI-driven platform.

Generate voice audio preview

Tool to generate a short audio preview with the specified voice and text.

Get current user information

Tool to retrieve the profile information of the currently authenticated user.

Get photo avatar details

Tool to retrieve detailed information about a photo avatar or look using its unique ID.

Get template by id

Retrieves a specific template from the HeyGen platform using its unique identifier.

Get training job status

Tool to retrieve the current training status and details of a photo avatar training job by group ID.

Interrupt streaming session

Interrupts an ongoing streaming session with an interactive avatar.

Keep alive streaming session

Tool to reset the idle timeout counter for an active streaming session.

List all avatar groups

Tool to retrieve a list of all available avatar groups in your HeyGen account.

List all locales for voices

Tool to retrieve available locales for multilingual voices.

List assets

Tool to retrieve a paginated list of all assets (images, audios, videos) created under your account.

List available voices

Retrieves a list of available voice models and options that can be used with HeyGen's AI-driven video creation platform.

List avatars endpoint

Retrieves a list of available avatars from the Heygen platform.

List avatars in a specific group

Tool to retrieve all avatars that belong to a specific avatar group.

List brand voices

Tool to retrieve a list of brand glossaries created under your account.

List folders

Tool to retrieve a paginated list of folders created under your account.

List knowledge bases

Tool to retrieve a list of all existing knowledge bases associated with your account.

List session history

Tool to retrieve a paginated history of all streaming sessions with metadata including session duration, timestamps, and other details.

List streaming avatars

Tool to retrieve a list of public and custom interactive avatars for streaming.

List talking photo entries

Retrieves a list of talking photos created using the HeyGen platform.

List TTS voices

Tool to retrieve a list of public and custom voices compatible with HeyGen's Starfish TTS model.

List videos

Retrieves a list of videos associated with the user's account on the HeyGen platform.

List voice endpoints

Retrieves a comprehensive list of all available voices in the HeyGen platform.

List webhook endpoints

Retrieves a list of all webhook endpoints configured for your HeyGen account.

List webhooks

Retrieves a list of all available webhook event types that can be subscribed to in your HeyGen account.

Move folder to trash

Tool to move a specific folder to trash by its unique folder ID.

Post streaming ice candidates

This endpoint is used to submit ICE (Interactive Connectivity Establishment) candidate information for a specific streaming session in the Heygen platform.

Post talking photo binary image

Creates a talking photo by processing an uploaded image file.

Post video translate request

The TranslateVideo endpoint enables the translation of video content from one language to another.

Restore folder from trash

Tool to restore a previously deleted folder from trash by its unique folder ID.

Retrieve all templates

Retrieves a list of available avatar templates from the HeyGen platform.

Retrieve avatar details

Tool to retrieve detailed information about a specific avatar by its ID.

Retrieve sharable video URL

Tool to generate a public, shareable URL for a specific video by ID.

Retrieve streaming list

Retrieves a list of active or available streaming sessions or content within the HeyGen platform.

Retrieve template details v3

Tool to retrieve comprehensive details about a specific template including all available variables for replacement and scene mappings for templates built in…

Retrieve user remaining quota

Retrieves the current remaining quota for the authenticated user on the HeyGen platform.

Retrieve video status details

Tool to retrieve the current processing status and metadata for a specific video by ID.

Retrieve video translation by id

Retrieves the current status of a video translation job in the HeyGen platform.

Retrieve video translation target languages

Retrieves a list of all available target languages supported by HeyGen's video translation feature.

Search public avatar groups

Tool to search and retrieve public avatar groups with optional filters and pagination.

Send task to streaming avatar

The StreamingTask endpoint initiates a real-time speaking task for an AI-driven avatar within an active streaming session.

Set streaming quality endpoint

Initiates a new streaming session with HeyGen, allowing users to start an avatar-based stream with specified quality settings.

Start streaming session

Initiates a new streaming session for real-time communication in the HeyGen platform.

Stop streaming session

The streaming.stop endpoint is used to terminate an active streaming session in the Heygen API.

Update folder name

Tool to update (rename) an existing folder by its unique folder ID.

Update knowledge base

Tool to update an existing knowledge base by its ID.

Update webhook endpoint

Tool to modify an existing webhook endpoint configuration including URL and subscribed event types.

Upload asset

Tool to upload a file asset (image, video, or audio) to HeyGen platform.

Upscale motion avatar

Tool to enhance the resolution and visual quality of a motion avatar.