# developers.heygen.com

> AI-optimized mirror of developers.heygen.com containing 51 pages totalling 65,410 words of clean markdown content, structured data, and semantic HTML. Original source: https://developers.heygen.com/. Last updated: 2026-05-01T02:01:34.526Z.

Each page is available as HTML (with JSON-LD structured data) and Markdown (text-only, ideal for LLMs and RAG).

## Homepage

- [site-root.html](/site-root.html) (1 words)

## Articles & Blog Posts

- [changelog/index.html](/changelog/index.html) (1 words)
- [mcp/overview/index.html](/mcp/overview/index.html) (1 words)
- [Connecting Your App to HeyGen with OAuth 2.0](/docs/connecting-your-app-to-heygen-with-oauth-20/index.html): Securely integrate your application with HeyGen using OAuth 2.0 (633 words)
- [Create Video Translation](/reference/create-video-translation/index.html): Translates a video into one or more target languages with voice cloning and lip-sync. Returns one video_translation_id per language. Use mode: 'speed' (default) for fast turnaround or 'precision' for higher lip-sync quality. (596 words)
- [List Video Translations](/reference/list-video-translations/index.html): Returns a paginated list of all video translation jobs in the account. (274 words)
- [HeyGen Cookbook Developer Welcome](/overview/index.html): The API docs show you how to call the endpoints. The cookbook shows you what to build., Discover HeyGen's developer documentation cookbook, guiding you to create unique videos and social media content effortlessly with real prompts, code, and step-by-step workflows. (324 words)
- [List Session Videos](/reference/list-session-videos/index.html): Returns all videos produced within a Video Agent session, sorted newest-first. (275 words)
- [List Avatar Looks](/reference/list-avatar-looks/index.html): Returns a paginated list of avatar looks (outfits, poses, styles). Filterable by group_id, avatar_type, and ownership. The look id is the avatar_id to pass when creating a video. (351 words)
- [Get Avatar Look](/reference/get-avatar-look/index.html): Returns details for a specific avatar look including supported engines, preferred orientation, preview URLs, and training status. (285 words)
- [List Videos](/reference/list-videos/index.html): Returns a paginated list of all videos in the account. Filterable by folder_id or title substring. (306 words)
- [Getting Your API Key](/docs/api-key/index.html) (331 words)
- [Update Video Translation](/reference/update-video-translation/index.html): Updates the display title of a video translation job. (275 words)
- [Design a Voice](/reference/design-a-voice/index.html): Returns up to 3 voices matching a natural language description (e.g. 'warm, confident female narrator'). Use the seed parameter to get different batches of results. (341 words)
- [Delete Video Translation](/reference/delete-video-translation/index.html): Permanently deletes a video translation and its associated files. This action cannot be undone. (183 words)
- [Get Avatar Group](/reference/get-avatar-group/index.html): Returns details for a specific avatar group including name, gender, preview URLs, looks count, and training status. (254 words)
- [Send Message or Request Revision](/reference/send-message-or-request-revision/index.html): Sends a follow-up message to an existing session. Use to answer agent questions, add context, or request edits to a generated video. Only valid for sessions created in chat mode. (337 words)
- [Get Video Agent Session](/reference/get-video-agent-session/index.html): Returns the current status, progress, video_id, and recent chat messages for a session. (244 words)
- [Get Session Resource](/reference/get-session-resource/index.html): Returns a single session resource (image, video, draft, avatar, voice, etc.) by its resource_id. (217 words)
- [Update Avatar Look](/reference/update-avatar-look/index.html): Updates the display name of an avatar look. Only supported for photo avatar and digital twin look types. (328 words)
- [List Avatar Groups](/reference/list-avatar-groups/index.html): Returns a paginated list of avatar groups (characters). Each group contains one or more looks. Filterable by ownership. (296 words)
- [Get Voice](/reference/get-voice/index.html): Returns details for a specific voice, including clone workflow status when available. Use this to poll a voice clone until its status is 'complete'. (214 words)
- [Get Video Translation](/reference/get-video-translation/index.html): Returns details for a translation job including status, output language, video_url, and failure info if applicable. (235 words)
- [Stop Video Agent Session](/reference/stop-video-agent-session/index.html): Halts an active agent run at its next checkpoint. Partial results are preserved. (212 words)
- [Delete Video](/reference/delete-video/index.html): Permanently deletes a video and its associated files. This action cannot be undone. (175 words)
- [lipsync-precision/index.html](/lipsync-precision/index.html) (1 words)
- [docs/video-agent/index.html](/docs/video-agent/index.html) (1 words)
- [image-to-video/index.html](/image-to-video/index.html) (1 words)
- [Generate Speech](/reference/generate-speech/index.html): Synthesize speech audio from text using a specified voice. The voice must support the starfish engine — use GET /v3/voices?engine=starfish to find compatible voices. Supports plain text and SSML. Speed range: 0.5–2.0x. Returns a URL to the generated audio file along with duration and optional word-level timestamps. (352 words)
- [HeyGen Documentation](/docs/voices/index.html): Browse available voices, design custom voices with AI, and use them in your videos. (640 words)
- [Styles are curated visual templates that control how the Video Agent composes your video — scene layout, script structure, pacing, and overall aesthetic. Apply a style by passing its `style_id` when creating a video.](/docs/styles-and-references/index.html): Browse and apply curated visual styles to Video Agent videos. (524 words)
- [HeyGen CLI Documentation](/cli/index.html): Get from zero to a generated video in minutes — right from your terminal. (483 words)
- [docs/create-avatar/index.html](/docs/create-avatar/index.html) (1 words)
- [Prerequisites](/generate-avatar-video/index.html): A Digital Twin is a lifelike avatar trained from real video footage of a person. Once created, you can make it speak any script in any supported voice — no camera or studio required. (466 words)
- [Create Video](/reference/create-video/index.html): Creates a video from a HeyGen avatar or an arbitrary image. Supports scripts or pre-recorded audio for lip-sync. Supports the Avatar IV engine and the upcoming Avatar V, while Avatar III video generation requires the legacy API (v1 or v2). (766 words)
- [Get your API key](/docs/quick-start/index.html): Get from zero to a generated video in minutes. (493 words)
- [Deprecation Timeline](/endpoint-version-comparison/index.html) (468 words)
- [List Video Agent Styles](/reference/list-video-agent-styles/index.html): Returns curated visual style templates available for Video Agent sessions. Each style controls scene composition, pacing, and aesthetics. Supports tag filtering (e.g. 'cinematic', 'retro-tech'). (269 words)
- [Quick Example](/docs/voices/speech/index.html): If you want to generate audio from text without creating a video, HeyGen offers a dedicated TTS engine called Starfish. Pass a script and a compatible voice ID — get back an audio file URL. (310 words)
- [Create Avatar](/reference/create-avatar/index.html): Creates a new avatar from an image, video footage, or a text prompt. Supports photo, digital_twin, and prompt types. Avatar training is asynchronous. (467 words)
- [Generate Video from Proofread](/reference/generate-video-from-proofread/index.html): Starts final video generation using the approved subtitles from a proofread session. (265 words)
- [Create Avatar Consent](/reference/create-avatar-consent/index.html): Initiates the consent flow for an avatar group and returns a URL for the user to complete approval in their browser. Required before a private avatar can be used for video generation. (294 words)
- [How Billing Works](/docs/pricing/index.html) (293 words)
- [Choosing the Right Video API](/docs/choosing-the-right-video-api/index.html): Compare Video Agent and direct video creation to pick the right approach for your use case. (369 words)
- [Create Video Agent Session](/reference/create-video-agent-session/index.html): One-shot video generation from a prompt — agent handles scripting, avatar selection, scene composition, and rendering. Supports generate (fire-and-forget) and chat (multi-turn) modes. (527 words)
- [List Voices](/reference/list-voices/index.html): Returns a paginated list of voices, filterable by type, engine, language, and gender. Use engine=starfish for voices compatible with the TTS endpoint. (296 words)
- [List Video Agent Sessions](/reference/list-video-agent-sessions/index.html): Returns a paginated list of video agent sessions for the authenticated user, sorted newest-first. (238 words)
- [Clone a Voice](/reference/clone-a-voice/index.html): Creates a voice clone from an audio file. Returns a voice_clone_id that can be polled via GET /v3/voices/{voice_clone_id} until the status is 'complete'. The resulting voice can be used with POST /v3/voices/speech and POST /v3/videos. (278 words)
- [Get Video](/reference/get-video/index.html): Returns details for a video including status, video_url, thumbnail_url, duration, and failure info if applicable. (266 words)
- [sitemap-xml.html](/sitemap-xml.html) (242 words)
- [RSS feeds](/llms-full-txt.html) (50,411 words)

## Resources

- [Full Page Index](/index.html): Browse all cached pages with rich metadata
- [About This Cache](/content/about.html): Methodology, technical details, and usage guidelines
- [XML Sitemap](/content/sitemap.xml): Machine-readable sitemap for crawler discovery
- [Robots.txt](/content/robots.txt): Crawler directives