upload_asset
Upload Asset
Upload an asset (image, video, or audio) to HeyGen from a public URL. The uploaded asset can be used as a background, audio input, or visual element in video generation.
upload_asset
Upload an asset (image, video, or audio) to HeyGen from a public URL. The uploaded asset can be used as a background, audio input, or visual element in video generation.
list_videos
List generated videos in your HeyGen account with pagination support. Returns video IDs, statuses, titles, and URLs.
list_avatars
Retrieve all available AI avatars in your HeyGen account, including both public and custom avatars. Returns avatar IDs needed for video generation, along with preview images and videos.
generate_speech
Generate natural-sounding speech audio from text using HeyGen's text-to-speech engine. Returns an audio URL suitable for narration, podcasts, IVR prompts, or use as audio input in video generation.
list_assets
List uploaded assets (images, videos, audio files) in your HeyGen account. Assets can be used as backgrounds, custom audio inputs, or visual elements in video generation.
create_video_from_prompt
Generate a video using the Video Agent from a simple natural language prompt. Instead of manually configuring scenes, avatars, and scripts, describe what you want and HeyGen's AI handles the rest — from scriptwriting to visual assembly.
translate_video
Translate a video into one or more target languages with natural voice cloning and lip-sync. Submit a video by URL or HeyGen video ID. Translation is asynchronous — use "Get Translation Status" to check progress.
list_voices
Retrieve all available voices for text-to-speech in HeyGen. Returns voice IDs needed for video generation and TTS, along with language, gender, and preview audio. Includes both HeyGen and ElevenLabs voices.
list_talking_photos
Retrieve all talking photos (photo avatars) in your HeyGen account. Talking photos are still images that can be animated to speak text. Their IDs can be used with character type "talking_photo" when creating avatar videos.
get_remaining_quota
Check remaining API credits and account quota. API usage is measured in credits — as a general rule, 1 credit = 1 minute of generated avatar video.
list_templates
List all available video templates in your HeyGen account. Returns template IDs and names. Use "Get Template" to see the dynamic variables for a specific template.
create_streaming_token
Create a session token for Interactive Avatar streaming. The token is used to establish a real-time streaming session where an avatar can respond to user input. Required before starting a streaming session in your application.
get_template
Retrieve details of a specific template including its dynamic variable definitions. Use this to understand what variables need to be provided when generating a video from a template.
get_video_status
Check the status of a video generation job and retrieve the completed video URL. Use this after creating a video to poll for completion. Returns the video URL, thumbnail, GIF preview, and duration once complete.
delete_video
Permanently delete a generated video from your HeyGen account.
create_avatar_video
Generate an AI avatar video with one or more scenes. Each scene has an avatar character, voice/script, and optional background. Supports multi-scene videos with different avatars, voices, and backgrounds per scene. Video generation is asynchronous — use **Get Video Status** to check when it's ready.
delete_asset
Permanently delete an uploaded asset from your HeyGen account.
generate_from_template
Generate a customized video from a HeyGen template by filling in dynamic variables. Templates are pre-designed in HeyGen's web interface and contain placeholders (e.g. `{{name}}`, `{{company}}`) that you populate via the API. Ideal for personalized videos at scale.
get_translation_status
Check the status of a video translation job and retrieve translated video URLs. Returns per-language translation status and video URLs once complete.
Generate AI avatar videos from text or audio scripts, with customizable avatars, voices, backgrounds, and multi-scene layouts. Translate videos into multiple languages with lip-sync. Create personalized video campaigns at scale using templates with dynamic variables. Stream real-time interactive avatar sessions for conversational AI experiences. Generate text-to-speech audio. Create photo avatar videos from uploaded photos. Upload and manage image, video, and audio assets. Monitor video generation status via webhooks and check account credit balances.
Common questions about connecting Heygen to AI agents with Metorial.