Heygen

Tool to add additional looks (images) to an existing photo avatar group. Use when you need to expand an avatar group with new image variations. Maximum 4 image keys can be added per request.

Tool to add natural motion or animation to an existing photo avatar, turning a still image into a moving, lifelike one. Use when you need to animate an avatar or add motion effects to a static photo avatar. The endpoint returns a new ID for the motion-enabled avatar.

Uploads a new asset (image, video, or audio) to the HeyGen platform. This endpoint allows users to upload media files that can be used in video generation, such as background images, audio tracks, or video clips. The uploaded asset will receive a unique ID that can be used in subsequent API calls (audio_asset_id, image_asset_id, or video_asset_id depending on file type). Use this tool when you need to upload media files to HeyGen for use in content creation.

Tool to retrieve the current status and details of a photo avatar or look generation by its ID. Use when you need to check if a photo avatar generation is complete or monitor generation progress.

Tool to create a new folder under your HeyGen account. Use when you need to organize content by creating a new folder. Once created, you can place videos in the folder by providing the folder_id parameter when generating videos.

Tool to create a new knowledge base with a specified name, opening line, and custom prompt for Interactive Avatar streaming sessions. Use when you need to set up a new knowledge base with custom AI behavior.

Tool to create an avatar group which can include both AI-generated and user-uploaded photos of the avatar. Use when you need to create a new avatar group for training or managing avatar photos.

Tool to delete a video by its ID from HeyGen account. Supports deletion of both generated (avatar) videos and translated videos. Use when you need to remove a video that is no longer required or to manage storage.

Tool to delete a specific asset by its unique asset ID from HeyGen account. Use when you need to remove an asset (image, video, or audio) that is no longer required.

Tool to delete a specific knowledge base by its ID. Use when you need to permanently remove a knowledge base from the HeyGen streaming platform.

Tool to delete a photo avatar by its ID from HeyGen account. Use when you need to remove a photo avatar that is no longer required.

Tool to generate a personalized AI avatar based on text prompts and attribute inputs. Use when you need to create custom AI-generated avatar photos with specific characteristics like age, gender, ethnicity, pose, and appearance details.

Tool to generate a short audio preview with the specified voice and text. Use when you need to synthesize short audio clips using selected voices before creating full videos. This is an Enterprise-only feature that consumes API credits and is currently in Beta.

Tool to retrieve the profile information of the currently authenticated user. Use when you need to fetch user details including username, email, full name, subscription status, and quotas.

Tool to retrieve the current training status and details of a photo avatar training job by group ID. Use when you need to check training progress, monitor job completion, or verify if training has finished successfully.

Tool to reset the idle timeout counter for an active streaming session. Use when you need to prevent a streaming session from timing out during periods of inactivity.

Tool to retrieve a list of all available avatar groups in your HeyGen account. Use when you need to fetch all avatar groups for content management or selection purposes.

Tool to retrieve all avatars that belong to a specific avatar group. Use when you need to fetch all avatars within a particular group for content management or selection purposes.

Tool to retrieve available locales for multilingual voices. Use when you need to access locale identifiers that can be used with multilingual voices for video generation.

Tool to retrieve a paginated list of all assets (images, audios, videos) created under your account. Use when you need to fetch assets for content management or track uploaded resources. Supports filtering by file type and folder, as well as cursor-based pagination.

Tool to retrieve a list of brand glossaries created under your account. Use when you need to access brand voice definitions that maintain consistent terminology and pronunciation across videos.

Tool to retrieve a paginated list of folders created under your account. Use when you need to organize or browse folder structures in HeyGen. Supports cursor-based pagination using the token parameter.

Tool to retrieve a list of all existing knowledge bases associated with your account. Use when you need to view available knowledge bases for streaming interactions.

Tool to retrieve a list of public and custom interactive avatars for streaming. Use when you need to fetch available avatars for interactive streaming sessions.

Tool to initiate a new streaming session with an Interactive Avatar for real-time interactions. Use when starting a new avatar streaming session to get WebSocket connection details including session_id, URL, and access_token.

This endpoint allows you to add one or more contacts to a specific personalized video project in the Heygen platform. It is used when you need to associate individual contact information with a project, likely for the purpose of creating tailored video content for each contact. The endpoint accepts a project identifier and a list of contacts, each with a first name and email address. This tool is essential for populating your project with recipient data, enabling the creation of personalized videos at scale. Note that this endpoint only adds contacts to a project; it does not initiate video creation or sending. Ensure that your project_id is valid and that all contact information is accurate to avoid errors in video personalization or delivery.

Retrieves detailed information about the audience for personalized videos. This endpoint provides insights into the target audience characteristics, preferences, and engagement metrics for HeyGen's AI-generated personalized video content. It can be used to gain a deeper understanding of the audience demographics, behavior patterns, and content preferences to optimize video creation and targeting strategies. The tool is particularly useful for content creators, marketers, and businesses looking to tailor their video content to specific audience segments using HeyGen's AI capabilities.

Retrieves detailed information about a specific personalized video project in the HeyGen platform. This endpoint allows you to fetch comprehensive data about a project, including its current status, configuration settings, and any other relevant metadata. Use this when you need to get an up-to-date overview of a particular video project, such as checking its progress, reviewing its settings, or gathering information for reporting purposes. The endpoint is read-only and does not modify any project data. Note that it may not include the actual video content itself, but rather focuses on the project's attributes and status.

Tool to retrieve detailed information about a photo avatar or look using its unique ID. Use when you need to get comprehensive information about a specific photo avatar including status, metadata, and configuration details.

Creates a talking photo by processing an uploaded image file. This endpoint enables users to transform static images into interactive, speaking visual content using HeyGen's advanced AI technology. It accepts JPEG or PNG image files and likely combines them with audio narration (though audio input is not specified in this schema). Use this endpoint when you want to generate engaging, personalized content from still images, such as creating speaking avatars or animated photographs. The endpoint is particularly useful for marketing materials, educational content, or personalized messages. Note that while image upload is specified, the method for providing or generating the associated audio is not detailed in this schema.

Tool to restore a previously deleted folder from trash by its unique folder ID. Use when you need to recover a folder that was moved to trash.

Tool to retrieve detailed information about a specific avatar by its ID. Use when you need to get comprehensive information about an avatar including identification details, display properties, and preview media URLs.

Tool to generate a public, shareable URL for a specific video by ID. Use when you need to create a public link that allows anyone to view the video without authentication. The generated URL can be shared with anyone and does not require HeyGen account access.

Tool to retrieve comprehensive details about a specific template including all available variables for replacement and scene mappings for templates built in the New AI Studio. Use when you need to understand the structure, available customization options, variables, and scene configurations of a template before generating videos from it.

Tool to retrieve the current processing status and metadata for a specific video by ID. Use when you need to check video processing progress, get time-limited URLs for video downloads, or monitor video generation completion. Note that returned URLs expire after 7 days but can be regenerated by calling this endpoint again.

Retrieves a list of available avatars for streaming purposes in the HeyGen platform. This endpoint allows developers to access the collection of realistic avatars that can be used for creating professional-looking videos with AI-generated content. It's designed to support applications requiring dynamic or live video content, enabling real-time access to the avatar library. The endpoint should be used when you need to fetch the current set of available avatars for integration into streaming or video generation workflows. It may not provide detailed information about each avatar's capabilities or customization options, focusing instead on delivering a quick, up-to-date list for immediate use in streaming contexts.

Creates a new streaming token for use with HeyGen's real-time avatar and voice chat services. This endpoint generates a unique, time-limited token that authenticates and authorizes access to HeyGen's streaming capabilities. Use this endpoint when initiating a new streaming session or when the previous token has expired. The generated token is typically for one-time use and should be obtained shortly before starting a streaming interaction. Note that this endpoint does not initiate the streaming itself; it only provides the necessary credentials for subsequent streaming API calls.

This endpoint is used to submit ICE (Interactive Connectivity Establishment) candidate information for a specific streaming session in the Heygen platform. It plays a crucial role in establishing and managing peer-to-peer connections for real-time communication and streaming of avatar content. The endpoint should be called when new ICE candidates are discovered during the connection setup process, typically as part of the WebRTC negotiation. It's essential for ensuring optimal connectivity between clients, especially in scenarios involving NAT traversal or complex network environments. This endpoint does not return the status of the connection or initiate the streaming itself; it only submits candidate information to be used in the connection process.

Interrupts an ongoing streaming session with an interactive avatar. This endpoint allows immediate termination of the avatar's current action or speech, providing control over the flow of interaction. Use this when you need to abruptly stop the avatar's current behavior, such as when changing topics or responding to user input that requires a different response. The interruption is immediate and irreversible, so use it judiciously to maintain a smooth user experience. This endpoint is particularly useful in scenarios where real-time responsiveness is crucial, like in customer service applications or interactive presentations.

Retrieves a list of active or available streaming sessions or content within the HeyGen platform. This endpoint allows users to get an overview of ongoing streams, which may include live avatar interactions, real-time video generations, or other streaming content created using HeyGen's AI-driven tools. It's particularly useful for monitoring current streaming activities or checking the availability of streams for integration into applications. The endpoint returns basic information about each stream, such as stream IDs, status, and possibly metadata, but does not provide the actual stream content. Use this when you need to track or display a list of active streams in your application's interface or for administrative purposes.

Initiates a new streaming session with HeyGen, allowing users to start an avatar-based stream with specified quality settings. This endpoint should be used when starting a new interactive content session or when creating a personalized digital avatar stream. It sets up the initial configuration for the streaming quality, which affects the overall user experience and bandwidth usage. The endpoint does not handle the actual streaming content or avatar creation; it only establishes the session parameters.

Initiates a new streaming session for real-time communication in the HeyGen platform. This endpoint is used to set up a WebRTC connection for video, audio, and data streaming, likely for interactions with AI avatars. It requires a unique session ID and a Session Description Protocol (SDP) offer to establish the connection. This endpoint should be called when starting a new interactive session with a HeyGen AI avatar or when initiating a live streaming event. It's crucial for setting up the initial parameters of the real-time communication channel.

The streaming.stop endpoint is used to terminate an active streaming session in the Heygen API. This endpoint should be called when you want to end a real-time data transfer session, such as when closing an interactive avatar conversation or stopping a live content stream. It's particularly useful for freeing up server resources and ensuring proper closure of streaming connections. The endpoint requires the unique session_id to identify which specific session to stop, allowing for precise control over multiple concurrent sessions. Note that once a session is stopped, it cannot be resumed; a new session must be started if streaming is needed again.

The StreamingTask endpoint initiates a real-time speaking task for an AI-driven avatar within an active streaming session. It enables developers to make avatars vocalize specified text, creating interactive and dynamic user experiences. This endpoint should be used when you want to generate speech from an avatar in response to user input or as part of a scripted interaction. It's particularly useful for applications requiring real-time avatar interactions, such as virtual assistants, interactive presentations, or educational content. Note that this endpoint requires an active streaming session, and the avatar's voice and appearance are determined by the session configuration.

Tool to move a specific folder to trash by its unique folder ID. Use when you need to delete a folder from HeyGen (soft delete - can be recovered later).

Tool to update an existing knowledge base by its ID. Use when you need to modify the name, opening line, or custom prompt of a knowledge base for Interactive Avatar streaming sessions.

Tool to modify an existing webhook endpoint configuration including URL and subscribed event types. Use when you need to update webhook settings or change event subscriptions for an existing endpoint.

Tool to enhance the resolution and visual quality of a motion avatar. Use when you need to improve avatar quality for higher resolution output. Important: Upscaling can ONLY be performed on motion avatars/looks - the avatar must first have motion added using the Add Motion endpoint.

Retrieves a list of available avatars from the Heygen platform. This endpoint allows users to fetch both public and private avatars, depending on their access rights and the specified parameters. It's particularly useful for applications that need to display available avatars to users for selection or customization. The endpoint supports pagination to handle large numbers of avatars efficiently. Use this when you need to present avatar options to users, manage avatar inventories, or sync local avatar data with the Heygen platform. Note that the response will likely include basic information about each avatar, such as ID, name, and type, but may not include full avatar details or assets.

Retrieves a list of talking photos created using the HeyGen platform. This endpoint allows users to fetch information about their existing talking photo projects, which are interactive images capable of speaking and engaging users. It's useful for managing and reviewing your talking photo content, or for integrating talking photo information into your application. The endpoint returns details about each talking photo, potentially including identifiers, creation dates, and associated metadata. Note that this endpoint likely returns all talking photos by default, so for users with a large number of projects, implementing client-side filtering or pagination may be necessary.

The video.delete endpoint allows users to remove a specific video from their HeyGen account. This operation moves the video to the trash, from where it can be restored if needed. Use this endpoint when you want to delete a video that is no longer required or to manage your account's storage. It's important to note that this action doesn't permanently delete the video immediately, as it can be restored from the trash. Exercise caution when using this endpoint, as deleted videos may not be recoverable after a certain period.

Retrieves a list of videos associated with the user's account on the HeyGen platform. This endpoint is crucial for content management, allowing users to view and organize their video library efficiently. It provides an overview of all videos created or managed through the HeyGen service, including AI-generated videos with custom avatars. Use this endpoint when you need to display a comprehensive list of videos, manage content, or track video creation progress. The response likely includes metadata for each video such as title, creation date, duration, and status. Note that this endpoint does not provide the actual video content or detailed analytics; it's primarily for listing and basic information retrieval.

Retrieves the current status of a video in the HeyGen platform. This endpoint is used to check the progress of video processing, particularly useful for avatar videos that may require time to generate. It provides real-time information on whether the video is still being processed or has been completed. Use this endpoint to monitor the state of your video creation requests and determine when a video is ready for further actions or viewing. The status returned can help in managing user expectations and workflow sequencing in applications integrating HeyGen's video generation capabilities.

Retrieves a comprehensive list of all available voices in the HeyGen platform. This endpoint should be used when you need to obtain information about the voice options that can be utilized for avatar creation or text-to-speech functionalities. The returned list likely includes details such as voice IDs, names, languages, and potentially other characteristics like gender or accent. It's particularly useful for applications that need to present voice choices to users or for initializing voice-related features. Note that this endpoint does not provide audio samples of the voices; it only lists their metadata.

Adds a new webhook endpoint to receive real-time notifications for specified Heygen events. This endpoint allows you to configure where and for which events you want to receive updates, enabling seamless integration of Heygen's capabilities into your application. Use this when you need to set up automated responses to specific events in the Heygen platform, such as avatar creation or video completion. The webhook will send POST requests to the specified URL whenever the subscribed events occur. Note that you may need to implement proper security measures on your receiving endpoint to validate incoming webhook requests.

Deletes a specific webhook endpoint from the HeyGen system. This operation permanently removes the configured webhook, stopping any future notifications or data transmissions to the previously specified URL. Use this endpoint when you no longer need to receive real-time updates for certain events or when you want to change your webhook configuration. Once deleted, you will need to create a new webhook endpoint if you wish to resume notifications. This action cannot be undone, so use it with caution. The deletion is typically immediate, but allow for a short processing time to ensure all systems are updated.

Retrieves a list of all webhook endpoints configured for your HeyGen account. This endpoint allows you to view and manage the webhook configurations that receive notifications about various events in your HeyGen integration. Use this endpoint to monitor your existing webhook setups, verify their status, or gather information for updating or removing webhooks. The response will likely include details such as the endpoint URLs, associated event types, and current status of each webhook. This tool is particularly useful for developers managing multiple webhook integrations or troubleshooting notification issues within their HeyGen-powered applications.

Retrieves a list of all webhooks configured for your HeyGen account. This endpoint allows you to view and manage the webhook integrations set up to receive real-time notifications about events in your HeyGen workspace, such as video generation status updates or avatar creation completions. Use this endpoint when you need to audit your existing webhook configurations, verify webhook URLs, or prepare for updating or deleting specific webhooks. The response typically includes details such as webhook IDs, target URLs, and the types of events each webhook is subscribed to. Note that this endpoint does not create, modify, or delete webhooks; it only provides a read-only view of your current webhook configurations.

Retrieves a list of available avatars from the HeyGen platform. This endpoint allows users to access the vast library of realistic avatars that can be used for video creation. It should be used when you need to browse or select avatars for your projects, such as creating marketing videos, educational content, or social media posts. The endpoint returns basic information about each avatar, which may include identifiers, names, and preview images. It does not provide detailed customization options or allow for avatar creation; it's purely for listing existing avatars. Keep in mind that the returned list may be paginated, and additional calls might be needed to retrieve the full set of avatars.

Deletes a specific talking photo from the HeyGen platform using its unique identifier. This endpoint should be used when you need to permanently remove a talking photo resource, such as when it's no longer needed or to manage storage. Once deleted, the talking photo cannot be recovered, so use this endpoint with caution. It's important to note that this operation does not affect any videos or content that may have already been generated using this talking photo.

This endpoint generates a customized video based on a pre-existing template using HeyGen's AI-driven platform. It allows for dynamic content creation by accepting a video title and a set of variables that can be used to personalize the video content. The endpoint is ideal for creating tailored videos at scale, such as personalized marketing content, educational materials, or customized presentations. It supports optional features like test mode for preliminary checks, caption enablement for accessibility, and custom video dimensions for various output formats. This tool should be used when you need to produce videos with consistent structure but varying content, leveraging HeyGen's AI avatars and text-to-speech capabilities to create engaging, personalized video experiences.

Retrieves a specific template from the HeyGen platform using its unique identifier. This endpoint allows users to access detailed information about a particular template, including its structure, elements, and customization options. It's particularly useful when you need to review or use an existing template for video creation or modification. The endpoint returns comprehensive template data, which may include settings for avatars, content placeholders, and customization parameters. Use this when you want to fetch the complete details of a known template before applying it to create or edit a video. Note that this endpoint retrieves template information only and does not create or modify any content.

Retrieves a list of available avatar templates from the HeyGen platform. This endpoint allows users to access pre-designed avatars that can be used for creating professional-looking videos. It's particularly useful when you need to browse or select from HeyGen's library of realistic avatars for your video projects. The endpoint returns template information, which likely includes details such as template IDs, names, preview images, and customization options. Use this endpoint when you want to display available avatar options to users or when you need to select a template for video generation.

Retrieves the current remaining quota for the authenticated user on the HeyGen platform. This endpoint allows users to check their available resources or actions within their account limits. It should be used to monitor usage and plan resource allocation effectively. The returned information helps users understand how much of their quota is left before reaching account limits. Note that this endpoint does not provide details on total quota or usage history, focusing solely on the remaining available quota.

Generates a customized video using Heygen's AI-driven platform. This endpoint allows you to create videos featuring digital avatars with specified voices, enabling dynamic content creation. It's ideal for producing personalized video content, such as explainer videos, product demonstrations, or interactive presentations. The endpoint supports multiple input configurations, allowing for complex video scenarios with different characters and voices. Use this when you need to programmatically create AI-generated videos with specific avatar and voice combinations. Note that while the endpoint offers extensive customization, real-time video generation is not supported, and processing times may vary based on complexity and system load.

The TranslateVideo endpoint enables the translation of video content from one language to another. It offers flexible options for translating either the entire video or just the audio track, accommodating various use cases. This tool is ideal for creating multilingual versions of video content, making it accessible to a global audience. The endpoint requires specifying the source video URL and the desired output language, with additional options to customize the translation process, such as handling multiple speakers and setting a title for the translated video. Use this endpoint when you need to quickly and efficiently translate video content while maintaining the integrity of the original presentation.

Retrieves the current status of a video translation job in the HeyGen platform. This endpoint allows users to check the progress of their requested video translations, providing information such as whether the translation is in progress, completed, or if any errors have occurred. It should be used when tracking the state of an ongoing translation task or to confirm if a translation has finished processing. The endpoint does not modify the translation job or initiate new translations; it's purely for status checking purposes.

Retrieves a list of all available target languages supported by HeyGen's video translation feature. This endpoint should be used when you need to know which languages are available for translating your video content. It provides an up-to-date array of supported languages, including various dialects and locales, allowing you to make informed decisions about your video translation projects. The endpoint does not require any parameters and will return the complete list of supported languages, which currently includes over 77 options. This tool is particularly useful for planning multilingual content strategies or when preparing to use HeyGen's video translation services.

Retrieves a list of available voice models and options that can be used with HeyGen's AI-driven video creation platform. This endpoint provides information about the various voice options, including different languages and voice characteristics, which can be applied to avatars in generated videos. Use this endpoint when you need to present users with voice choices for their video projects or when implementing voice customization features in your application. The returned data likely includes details such as voice ID, language, gender, and other relevant attributes for each available voice model. This endpoint is essential for applications that want to offer a range of voice options to enhance the personalization of AI-generated video content.