- Category: media generation
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 78
- Triggers: 0
- Slug:
HEYGEN - Version: 20261101_00
Tools
Add looks to photo avatar group
Add looks to photo avatar group
HEYGEN_ADD_LOOKS_TO_PHOTO_AVATAR_GROUPTool 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.Input Parameters
Output
Add motion to photo avatar
Add motion to photo avatar
HEYGEN_ADD_MOTIONTool 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.Input Parameters
Output
Check photo/look generation status
Check photo/look generation status
HEYGEN_CHECK_PHOTO_LOOK_GENERATION_STATUSRetrieve the status and available image details of a photo avatar or look generation by ID. Use it to monitor progress and check whether generation is complete.Input Parameters
Output
Create a new folder
Create a new folder
HEYGEN_CREATE_FOLDERTool 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.Input Parameters
Output
Create knowledge base
Create knowledge base
HEYGEN_CREATE_KNOWLEDGE_BASETool 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.Input Parameters
Output
Create photo avatar group
Create photo avatar group
HEYGEN_CREATE_PHOTO_AVATAR_GROUPTool 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.Input Parameters
Output
Create WebM video
Create WebM video
HEYGEN_CREATE_WEBM_VIDEOTool to create a WebM format video with transparent background featuring an avatar speaking text or audio. Use when you need to generate WebM videos with transparent backgrounds for overlaying on other content. Note that this API endpoint does not support custom avatars - only HeyGen’s studio avatars are supported. The output format will be WebM instead of MP4 to preserve transparency.Input Parameters
Output
Delete an avatar video
Delete an avatar video
Delete asset
Delete asset
Delete knowledge base
Delete knowledge base
Delete photo avatar
Delete photo avatar
Delete photo avatar group
Delete photo avatar group
Delete webhook endpoint
Delete webhook endpoint
Generate photo avatar photos
Generate photo avatar photos
HEYGEN_GENERATE_PHOTO_AVATAR_PHOTOSTool 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.Input Parameters
Output
Generate text-to-speech audio
Generate text-to-speech audio
HEYGEN_GENERATE_TEXT_TO_SPEECHTool to generate a speech audio file from any text input using a specified voice, powered by HeyGen’s Starfish model. Use when you need to convert text to speech audio with high-quality voice synthesis.Input Parameters
Output
Generate voice audio preview
Generate voice audio preview
HEYGEN_GENERATE_VOICE_AUDIO_PREVIEWTool 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.Input Parameters
Output
Get Asset
Get Asset
Get Avatar Group
Get Avatar Group
Get Avatar Look
Get Avatar Look
Get current user information
Get current user information
Get training job status
Get training job status
HEYGEN_GET_TRAINING_JOB_STATUSTool 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.Input Parameters
Output
Get Voice
Get Voice
Keep alive streaming session
Keep alive streaming session
List all avatar groups
List all avatar groups
List all locales for voices
List all locales for voices
List assets
List assets
HEYGEN_LIST_ASSETSTool 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.Input Parameters
Output
List Avatar Groups
List Avatar Groups
List Avatar Looks
List Avatar Looks
List brand voices
List brand voices
List folders
List folders
HEYGEN_LIST_FOLDERSTool 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.Input Parameters
Output
List avatars in a specific group
List avatars in a specific group
HEYGEN_LIST_GROUP_AVATARSTool 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.Input Parameters
Output
List knowledge bases
List knowledge bases
List session history
List session history
HEYGEN_LIST_SESSION_HISTORYTool to retrieve a paginated history of all streaming sessions with metadata including session duration, timestamps, and other details. Use when you need to view historical streaming session data for reporting or analysis purposes.Input Parameters
Output
List streaming avatars
List streaming avatars
List TTS voices
List TTS voices
List V3 Voices
List V3 Voices
Create new streaming session
Create new streaming session
HEYGEN_NEW_SESSIONTool 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.Input Parameters
Output
Add contact to personalized video project
Add contact to personalized video project
HEYGEN_PERSONALIZED_VIDEO_ADD_CONTACTThis 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.Input Parameters
Output
Fetch personalized video project detail
Fetch personalized video project detail
HEYGEN_PERSONALIZED_VIDEO_PROJECT_DETAILRetrieves detailed information about a specific personalized video project in HeyGen, including status, settings, and metadata. Use this to check project progress or review configuration. Read-only endpoint. The project ID must be obtained from the HeyGen web interface - there is no API to list projects. Go to Personalized Video section, select a project, and copy the Project ID from the API setup page. May require Enterprise subscription.Input Parameters
Output
Get photo avatar details
Get photo avatar details
HEYGEN_PHOTO_AVATAR_DETAILSTool 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.Input Parameters
Output
Post talking photo binary image
Post talking photo binary image
Restore folder from trash
Restore folder from trash
Retrieve avatar details
Retrieve avatar details
HEYGEN_RETRIEVE_AVATAR_DETAILSTool 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.Input Parameters
Output
Retrieve sharable video URL
Retrieve sharable video URL
HEYGEN_RETRIEVE_SHARABLE_VIDEO_URLTool 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. Generated URLs may be time-limited; call this tool again to refresh the link if it expires.Input Parameters
Output
Retrieve template details v3
Retrieve template details v3
HEYGEN_RETRIEVE_TEMPLATE_DETAILS_V3Tool 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.Input Parameters
Output
Retrieve video status details
Retrieve video status details
HEYGEN_RETRIEVE_VIDEO_STATUS_DETAILSTool 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. Video rendering is asynchronous and typically takes 30–180+ seconds; poll at moderate intervals rather than tight loops. Verify returned URLs are accessible before surfacing to users. Note that returned URLs expire after 7 days but can be regenerated by calling this endpoint again.Input Parameters
Output
Search public avatar groups
Search public avatar groups
HEYGEN_SEARCH_PUBLIC_AVATAR_GROUPSTool to search and retrieve public avatar groups with optional filters and pagination. Use when you need to find specific avatar groups by tags, name, or browse available public avatars.Input Parameters
Output
Create streaming token with expiry
Create streaming token with expiry
HEYGEN_STREAMING_CREATE_TOKENCreates 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.Input Parameters
Output
Post streaming ice candidates
Post streaming ice candidates
HEYGEN_STREAMING_ICEThis 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.Input Parameters
Output
Interrupt streaming session
Interrupt streaming session
HEYGEN_STREAMING_INTERRUPTInterrupts 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.Input Parameters
Output
Retrieve streaming list
Retrieve streaming list
HEYGEN_STREAMING_LISTRetrieves 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.Output
Set streaming quality endpoint
Set streaming quality endpoint
HEYGEN_STREAMING_NEWInitiates 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.Input Parameters
Output
Start streaming session
Start streaming session
Stop streaming session
Stop streaming session
HEYGEN_STREAMING_STOPThe 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.Input Parameters
Output
Send task to streaming avatar
Send task to streaming avatar
HEYGEN_STREAMING_TASKThe 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.Input Parameters
Output
Move folder to trash
Move folder to trash
Update folder name
Update folder name
Update knowledge base
Update knowledge base
HEYGEN_UPDATE_KNOWLEDGE_BASEUpdate an existing knowledge base by ID for Interactive Avatar streaming sessions. The name and opening line are required on every request; a custom prompt can also be supplied.Input Parameters
Output
Update webhook endpoint
Update webhook endpoint
HEYGEN_UPDATE_WEBHOOK_ENDPOINTTool 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.Input Parameters
Output
Upload asset
Upload asset
HEYGEN_UPLOAD_ASSETTool to upload a file asset (image, video, or audio) to HeyGen platform. Use when you need to upload media files for use in video generation or other HeyGen services.Input Parameters
Output
Upscale motion avatar
Upscale motion avatar
HEYGEN_UPSCALE_AN_AVATARTool 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.Input Parameters
Output
List avatars endpoint
List avatars endpoint
List talking photo entries
List talking photo entries
HEYGEN_V1_TALKING_PHOTO_LISTRetrieves 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.Output
List videos
List videos
List voice endpoints
List voice endpoints
Add webhook endpoint
Add webhook endpoint
HEYGEN_V1_WEBHOOK_ENDPOINT_ADDAdds 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.Input Parameters
Output
List webhook endpoints
List webhook endpoints
HEYGEN_V1_WEBHOOK_ENDPOINT_LISTRetrieves 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.Output
List webhooks
List webhooks
HEYGEN_V1_WEBHOOK_WEBHOOK_LISTRetrieves a list of all available webhook event types that can be subscribed to in your HeyGen account. This endpoint returns the complete list of event types that HeyGen supports for webhook notifications, such as avatar video success/failure events, video translation events, personalized video events, instant avatar events, photo avatar events, and more. Use this endpoint when you need to discover which webhook events are available for subscription before configuring your webhook endpoints. Note that this endpoint only lists the available event types - to manage actual webhook endpoint configurations, use the webhook endpoint.list, endpoint.add, and endpoint.delete endpoints.Output
Delete talking photo by id
Delete talking photo by id
HEYGEN_V2_TALKING_PHOTO_ID_DELETEDeletes 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.Input Parameters
Output
Generate video template with variables
Generate video template with variables
HEYGEN_V2_TEMPLATE_GENERATEGenerates a customized video from a pre-existing template using HeyGen’s AI platform. Accepts a video title and template variables to personalize content. Ideal for creating tailored videos at scale like personalized marketing, educational content, or custom presentations. Supports test mode, captions, and custom dimensions. IMPORTANT: First retrieve template variable definitions using ‘Get template by id’ (GET /v2/template/{id}). Variable names must exactly match those from that endpoint, or the API will reject with ‘Invalid variable name’ error.Input Parameters
Output
Get template by id
Get template by id
Retrieve all templates
Retrieve all templates
Retrieve user remaining quota
Retrieve user remaining quota
Generate video with inputs
Generate video with inputs
HEYGEN_V2_VIDEO_GENERATEGenerates 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.Input Parameters
Output
Post video translate request
Post video translate request
HEYGEN_V2_VIDEO_TRANSLATEThe 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.Input Parameters
Output
Retrieve video translation by id
Retrieve video translation by id
HEYGEN_V2_VIDEO_TRANSLATE_ID_STATUSRetrieves 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.Input Parameters
Output
Retrieve video translation target languages
Retrieve video translation target languages
HEYGEN_V2_VIDEO_TRANSLATE_TARGET_LANGUAGESRetrieves 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.Output
List available voices
List available voices
HEYGEN_V2_VOICESRetrieves 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.