HeyGen for AI agents
Agents read HeyGen at once. Changes and sends are held for a person's approval by default.
About HeyGen
HeyGen is an innovative video platform that harnesses the power of generative AI to streamline your video creation process
What an agent can do in HeyGen
Every HeyGen action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in HeyGen without asking first. 38 actions.
- Get current user informationTool 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.
- 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 filt
- 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
- List streaming avatarsTool to retrieve a list of public and custom interactive avatars for streaming. Use when you need to fetch available avatars for interactive streaming sessions.
- 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 pr
- 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 vide
- List videosRetrieves 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 efficient
- List voice endpointsRetrieves 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
- Retrieve all templatesRetrieves 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 parti
- Retrieve user remaining quotaRetrieves 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
- List available 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 d
- Check photo/look generation statusTool 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.
Show all 38
- Get AssetRetrieve metadata and the public URL for one HeyGen workspace asset.
- Get Avatar GroupRetrieve one HeyGen v3 avatar group by its identifier.
- Get Avatar LookRetrieve a HeyGen v3 avatar look and its rendering compatibility.
- 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 fin
- List all avatar groupsTool 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.
- List all locales for voicesTool 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.
- List Avatar GroupsBrowse HeyGen v3 avatar groups by ownership with cursor pagination.
- List Avatar LooksBrowse generation-ready avatar looks and their engine compatibility.
- List brand voicesTool 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.
- 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
- List avatars in a specific groupTool 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.
- List knowledge basesTool 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.
- List TTS voicesTool to retrieve a list of public and custom voices compatible with HeyGen's Starfish TTS model. Use when you need to access available voices for text-to-speech audio generation in videos.
- List V3 VoicesBrowse HeyGen v3 voices using catalog, engine, language, and gender filters.
- Fetch 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 en
- Get 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
- 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 und
- 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.
- Retrieve 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 intera
- List avatars endpointRetrieves 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
- List talking photo entriesRetrieves 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
- List webhook endpointsRetrieves 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
- List webhooksRetrieves 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 notifica
- Get template by idRetrieves 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, elem
- Retrieve video translation by idRetrieves 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 wh
- Retrieve video translation 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 you
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 38 actions.
- Create new streaming 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_i
- Send task to streaming avatarThe 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 inter
- Generate video template with variablesGenerates 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 l
- 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.
- Add motion to photo avatarTool 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 a
- Create a new 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 param
- 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 be
- 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.
- 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 othe
- Delete an avatar videoTool 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 ma
- Delete assetTool 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.
- Delete knowledge baseTool to delete a specific knowledge base by its ID. Use when you need to permanently remove a knowledge base from the HeyGen streaming platform.
Show all 38
- Delete photo avatarTool 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.
- Delete photo avatar groupTool to delete a photo avatar group by its ID from HeyGen account. Use when you need to remove a photo avatar group that is no longer required.
- Delete webhook endpointTool to permanently delete a webhook endpoint from HeyGen. Use when you no longer need to receive webhook notifications for a specific endpoint.
- 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, ethn
- Generate text-to-speech audioTool 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 synthesi
- 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-onl
- Keep alive streaming sessionTool 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.
- Add contact to personalized video projectThis 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 projec
- Post talking photo binary imageCreates 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
- Restore folder from trashTool 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.
- 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 sha
- Create streaming token with expiryCreates 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
- Post streaming ice candidatesThis 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
- Interrupt streaming sessionInterrupts 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.
- Set streaming quality endpointInitiates 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 sess
- Start streaming sessionInitiates 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
- Stop streaming sessionThe 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 clos
- Move folder to trashTool 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).
- Update folder nameTool to update (rename) an existing folder by its unique folder ID. Use when you need to change the name of a folder in HeyGen.
- Update knowledge baseTool 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.
- 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.
- Upscale motion 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 ava
- Add webhook endpointAdds 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 seaml
- Delete talking photo by idDeletes 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 l
- Generate video with inputsGenerates 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
- Post video translate requestThe 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, accommoda
Changes wait in Needs you
Changes and sends in HeyGen are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
HeyGen questions
Can an agent change data in HeyGen on its own?
Not by default. Changes and sends in HeyGen are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in HeyGen?
This connector lists 38 read actions. Reads run at once, without waiting for approval.
How does HeyGen connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.