Bulk Asset Statuses
ReadReturns statuses for up to 100 assets by assetids and/or batchids: queued, processing, completed, failed, or notfound.
Permissions and limits
Account permissions
- A HeyGen API key
Track and manage HeyGen videos, avatars, voices, templates, assets, brand kits and jobs.
Explore 103 workflow actions for HeyGen, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Returns statuses for up to 100 assets by assetids and/or batchids: queued, processing, completed, failed, or notfound.
Returns statuses for up to 100 lipsyncs by lipsyncids and/or batchids: queued, processing, completed, failed, or notfound.
Returns statuses for up to 100 videos in one request, addressed by comma-separated videoids and/or batchids query params.
Returns statuses for up to 100 video translations by videotranslationids and/or batchids: queued, processing, completed, failed, or notfound.
Creates a brand glossary.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a brand kit by importing logos, colors and fonts from a public website; by calling it you confirm you have the rights to use those assets.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a folder at the root or inside parentid.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a private template from one of your videos, copying its scenes, avatars, script and media.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a voice clone you own and frees its place in your clone limit.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Soft-deletes an AI clip job and its clips.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes the caller-owned model-backed audio voice.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes an asset.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes an avatar group and all its associated looks.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes an avatar look.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Soft-deletes a background removal job.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a brand glossary.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a brand kit and its colors, logos and fonts.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Soft-deletes a HyperFrames render.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes a lipsync job and its associated files.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Soft-deletes a podcast so it no longer appears in the get/list endpoints.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a proofread session, removing it from listings and from the workspace's projects.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Soft-deletes a template.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes a video and its associated files.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes a video translation and its associated files.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns the full job resource including produced clips, statuses, and presigned download URLs.
Returns one model-backed audio voice, owned by the caller's workspace or public, and its current lifecycle state.
Returns metadata for an asset in the caller's workspace , including owner, upload timestamp, file type, and a publicly accessible URL.
Returns batch aggregate status and one page of items with their ids and statuses.
Returns details for a specific avatar group including name, gender, preview URLs, looks count, and training status.
Returns details for a specific avatar look including supported engines, preferred orientation, preview URLs, and training status.
Returns a background removal job including its status and, once completed, presigned download URLs for the produced layers.
Returns one brand glossary with its full term list.
Returns one brand kit with its colors, logos and fonts and the role each plays.
Returns non-secret metadata, expiration, and permission scopes for the API key used to authenticate this request.
Returns the authenticated user's profile, remaining credits or balance, and billing details.
Returns the authenticated user's profile, remaining credits or balance, and billing details.
Returns metadata for a single custom agent.
Returns status + presigned output MP4 URL once the workflow completes.
Returns the job resource: lifecycle status, progress, and , once completed , the presigned download URL of the cleaned video plus removal statistics (numcuts, reductionpct, durations).
Returns one folder in your workspace, including one in the trash (istrash).
Return the generation job status and ordered images with fresh download URLs once the entire job completes.
Returns a HeyGen Video generation: pending, processing, completed, failed or cancelled.
Returns full details for a single HyperFrames render, including status and signed videourl when complete.
Return a generation created by POST /v3/images: its images with fresh download URLs once completed, its failure code once failed, or pending while the creating request is still running.
Returns details for a lipsync job including status, videourl, captionurl, and failure info if applicable.
Returns batch aggregate status and one page of items with their ids and statuses.
Return a music job created by POST /v3/audio/music: a fresh audiourl once completed, its failure code once failed, or pending while the creating request is still running.
Returns a podcast's status and, once completed, its videourl, thumbnailurl, and duration.
Returns the status and details of a proofread session.
Returns template details including its variable schema (with current default values) and scenes.
Return a transcription created by POST /v3/audio/transcriptions: its transcript once completed, its failure code once failed, or pending while the creating request is still running.
Returns details for a video including status, videourl, thumbnailurl, duration, and failure info if applicable.
Returns the current status, progress, videoid, and recent chat messages for a session.
Returns batch aggregate status and one page of items with their video ids and statuses.
Return a generation created by POST /v3/video-generations: pending while the model works, completed with a fresh videourl to the mp4, or failed with its failure code.
Return the latest state and result or terminal error for one comparison.
Return aggregate batch status and one cursor-paginated page of comparison items.
Returns a video's scenes as it stands now, with the editversion to send when editing.
Returns details for a translation job including status, output language, videourl, and failure info if applicable.
Returns batch aggregate status and one page of items with their ids and statuses.
Returns details for a specific voice, including clone workflow status when available.
Returns a single workflow definition, including its current mutable draft graph.
Returns a workflow run: its pinned version, timestamps, node progress, any terminal error and every declared output.
Returns a single immutable, compiled workflow version, including its full plan summary.
Returns a cursor-paginated list of AI clip jobs in the authenticated user's workspace, newest first.
Beta: may change with a few days' notice.
Returns model-backed audio voices, ordered newest first.
Returns a paginated list of avatar groups (characters).
Returns a paginated list of avatar looks (outfits, poses, styles).
Returns a paginated list of background removal jobs for the account, newest first.
Lists the brand glossaries in your workspace.
Returns brand kits available in the authenticated user's workspace.
Returns the installed custom agents.
Returns a cursor-paginated list of HyperFrames renders in the account, newest first.
Returns a paginated list of all lipsync jobs in the account.
Lists the look templates and Look Packs your workspace can apply with POST /v3/avatars/looks.
Returns a paginated list of the podcasts in the authenticated workspace, newest first.
Returns a paginated list of all proofread sessions in the workspace, newest first.
Returns all videos produced within a Video Agent session, sorted newest-first.
Returns all supported target language names for video translation.
Returns a paginated list of API-ready templates in the workspace.
Returns a paginated list of video agent sessions for the authenticated user, sorted newest-first.
Returns curated visual style templates available for Video Agent sessions.
Returns a paginated list of all video translation jobs in the account.
Returns a paginated list of all videos in the account.
Returns a paginated list of voices, filterable by type, engine, language, and gender.
Returns all available webhook event types with human-readable descriptions.
Discovery catalog of authorable node types, grouped by family with per-variant config schema and ports.
Paginated per-node diagnostics for one run: node id, status, timestamps, and a sanitized error for failed nodes.
Returns a paginated list of runs for the workflow named by the required workflowid query parameter, newest first.
Returns a paginated list of immutable, compiled versions for a workflow definition.
Returns a paginated list of workflow definitions.
Semantically search re-hosted public images and icons by natural-language description, e.g.
Searches the music or sound-effects catalog by natural-language description (type=music by default, or soundeffects).
Replaces a template's full set of variables: any variable you omit is removed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates an avatar group you own.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the display name of an avatar look.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a brand glossary.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates a brand kit's name or role assignments: color roles, main logo, heading and body fonts.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the display title of a lipsync job.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Renames a template.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the display title of a video translation job.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replaces the mutable draft product graph.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in HeyGen. A saved workflow is not a completed provider action.