71 available actions

What your AI agent can do in HeyGen

HeyGen is an innovative video platform that harnesses the power of generative AI to streamline your video creation process This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.

Common starting points

  • Get training job statusTool to retrieve the current training status and details of a photo avatar training job by group ID.
  • Search public avatar groupsTool to search and retrieve public avatar groups with optional filters and pagination.
  • 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.
  • Send task to streaming avatarThe StreamingTask endpoint initiates a real-time speaking task for an AI-driven avatar within an active streaming session.
  • Update folder nameTool to update (rename) an existing folder by its unique folder ID.
  • Update knowledge baseTool to update an existing knowledge base by its ID.

Browse all 71 actions by capability

Open a capability to see every supported action and its description.

Find & reviewLook up and review existing recordsView 33 actionsHide actions
  • Check photo/look generation statusTool to retrieve the current status and details of a photo avatar or look generation by its ID.
  • Get current user informationTool to retrieve the profile information of the currently authenticated user.
  • Get training job statusTool to retrieve the current training status and details of a photo avatar training job by group ID.
  • List all avatar groupsTool to retrieve a list of all available avatar groups in your HeyGen account.
  • List all locales for voicesTool to retrieve available locales for multilingual voices.
  • List assetsTool to retrieve a paginated list of all assets (images, audios, videos) created under your account.
  • List brand voicesTool to retrieve a list of brand glossaries created under your account.
  • List foldersTool to retrieve a paginated list of folders created under your account.
  • List avatars in a specific groupTool to retrieve all avatars that belong to a specific avatar group.
  • List knowledge basesTool to retrieve a list of all existing knowledge bases associated with your account.
  • List session historyTool to retrieve a paginated history of all streaming sessions with metadata including session duration, timestamps, and other details.
  • List streaming avatarsTool to retrieve a list of public and custom interactive avatars for streaming.
  • List TTS voicesTool to retrieve a list of public and custom voices compatible with HeyGen's Starfish TTS model.
  • Fetch personalized video project detailRetrieves detailed information about a specific personalized video project in HeyGen, including status, settings, and metadata.
  • Get photo avatar detailsTool to retrieve detailed information about a photo avatar or look using its unique ID.
  • Retrieve avatar detailsTool to retrieve detailed information about a specific avatar by its ID.
  • Retrieve sharable video URLTool to generate a public, shareable URL for a specific video by ID.
  • 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…
  • Retrieve video status detailsTool to retrieve the current processing status and metadata for a specific video by ID.
  • Search public avatar groupsTool to search and retrieve public avatar groups with optional filters and pagination.
  • Retrieve streaming listRetrieves a list of active or available streaming sessions or content within the HeyGen platform.
  • List avatars endpointRetrieves a list of available avatars from the Heygen platform.
  • List talking photo entriesRetrieves a list of talking photos created using the HeyGen platform.
  • List videosRetrieves a list of videos associated with the user's account on the HeyGen platform.
  • List voice endpointsRetrieves a comprehensive list of all available voices in the HeyGen platform.
  • List webhook endpointsRetrieves a list of all webhook endpoints configured for your HeyGen account.
  • List webhooksRetrieves a list of all available webhook event types that can be subscribed to in your HeyGen account.
  • Get template by idRetrieves a specific template from the HeyGen platform using its unique identifier.
  • Retrieve all templatesRetrieves a list of available avatar templates from the HeyGen platform.
  • Retrieve user remaining quotaRetrieves the current remaining quota for the authenticated user on the HeyGen platform.
  • Retrieve video translation by idRetrieves the current status of a video translation job in the HeyGen platform.
  • Retrieve video translation target languagesRetrieves a list of all available target languages supported by HeyGen's video translation feature.
  • List available voicesRetrieves a list of available voice models and options that can be used with HeyGen's AI-driven video creation platform.
Create & communicateCreate records or send supported messagesView 20 actionsHide actions
  • Add looks to photo avatar groupTool to add additional looks (images) to an existing photo avatar group.
  • 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.
  • Create a new folderTool to create a new folder under your HeyGen account.
  • Create knowledge baseTool to create a new knowledge base with a specified name, opening line, and custom prompt for Interactive Avatar streaming sessions.
  • Create photo avatar groupTool to create an avatar group which can include both AI-generated and user-uploaded photos of the avatar.
  • Create WebM videoTool to create a WebM format video with transparent background featuring an avatar speaking text or audio.
  • Generate photo avatar photosTool to generate a personalized AI avatar based on text prompts and attribute inputs.
  • 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.
  • Generate voice audio previewTool to generate a short audio preview with the specified voice and text.
  • Create new streaming sessionTool to initiate a new streaming session with an Interactive Avatar for real-time interactions.
  • 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.
  • Post talking photo binary imageCreates a talking photo by processing an uploaded image file.
  • Create streaming token with expiryCreates a new streaming token for use with HeyGen's real-time avatar and voice chat services.
  • Post streaming ice candidatesThis endpoint is used to submit ICE (Interactive Connectivity Establishment) candidate information for a specific streaming session in the Heygen platform.
  • Send task to streaming avatarThe StreamingTask endpoint initiates a real-time speaking task for an AI-driven avatar within an active streaming session.
  • Upload assetTool to upload a file asset (image, video, or audio) to HeyGen platform.
  • Add webhook endpointAdds a new webhook endpoint to receive real-time notifications for specified Heygen events.
  • Generate video template with variablesGenerates a customized video from a pre-existing template using HeyGen's AI platform.
  • Generate video with inputsGenerates a customized video using Heygen's AI-driven platform.
  • Post video translate requestThe TranslateVideo endpoint enables the translation of video content from one language to another.
Update & manageChange and manage existing recordsView 7 actionsHide actions
  • Restore folder from trashTool to restore a previously deleted folder from trash by its unique folder ID.
  • Set streaming quality endpointInitiates a new streaming session with HeyGen, allowing users to start an avatar-based stream with specified quality settings.
  • Start streaming sessionInitiates a new streaming session for real-time communication in the HeyGen platform.
  • Move folder to trashTool to move a specific folder to trash by its unique folder ID.
  • Update folder nameTool to update (rename) an existing folder by its unique folder ID.
  • Update knowledge baseTool to update an existing knowledge base by its ID.
  • Update webhook endpointTool to modify an existing webhook endpoint configuration including URL and subscribed event types.
Remove & cancelRemove records or cancel supported workView 7 actionsHide actions
  • Delete an avatar videoTool to delete a video by its ID from HeyGen account.
  • Delete assetTool to delete a specific asset by its unique asset ID from HeyGen account.
  • Delete knowledge baseTool to delete a specific knowledge base by its ID.
  • Delete photo avatarTool to delete a photo avatar by its ID from HeyGen account.
  • Delete photo avatar groupTool to delete a photo avatar group by its ID from HeyGen account.
  • Delete webhook endpointTool to permanently delete a webhook endpoint from HeyGen.
  • Delete talking photo by idDeletes a specific talking photo from the HeyGen platform using its unique identifier.
Other actionsSpecialist and administrative actions.View 4 actionsHide actions
  • Keep alive streaming sessionTool to reset the idle timeout counter for an active streaming session.
  • Interrupt streaming sessionInterrupts an ongoing streaming session with an interactive avatar.
  • Stop streaming sessionThe streaming.stop endpoint is used to terminate an active streaming session in the Heygen API.
  • Upscale motion avatarTool to enhance the resolution and visual quality of a motion avatar.

Connection record

A connection you can control.

Sign-in
Customer-managed key
Setup
Use a key you create and control. It is stored securely and limited to the work agreed for the role.
Boundaries
Only the approved role and actions.
Off switch
Revoke the connection from your account.

FAQ

Before you connect HeyGen

How does the agent connect to HeyGen?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in HeyGen?
The page above lists the 71 actions currently available through the HeyGen connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is HeyGen included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until HeyGen is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.

Bring the workflow together

Ready to put HeyGen to work?

Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.

All product names, logos, and brands are property of their respective owners and are used for identification only. ZeroToClaw is not affiliated with or endorsed by HeyGen.