HeyGen Avatar V
POST Base URL:
https://api.hiapi.ai /v1/tasks Image, video, and audio models are called through the Unified Async API POST /v1/tasks endpoint; only the input fields differ (see input parameters below).
Model summary
| Model | heygen-avatar-v |
|---|---|
| Capability | Avatar video |
| Driving method | Script and voice / driving audio |
| Output | MP4 / WebM, optional SRT |
Generate lip-synced avatar video from a script and preset voice or from driving audio.
Production guidance
Calling the API
- Use exactly one of prompt or audio_url.
- Use callback.url for terminal notifications and GET /v1/tasks/:id as a fallback query.
- Use output[].type to distinguish the video and caption files.
Best suited for
Script and voice
Pass prompt and select voice to generate the narration.
promptvoiceDriving audio
Pass audio_url to drive lip-sync directly, up to 600 seconds and 32 MiB.
audio_urlRequest parameters
model string required Model ID.
input object required HeyGen Avatar V parameters.
avatar string required Avatar preset. See all avatar presets ↓
prompt string optional Script, up to 5,000 characters. Use either prompt or audio_url.
voice string optional Voice used for script-driven video. See all voice presets ↓
audio_url string optional Audio URL. Use either audio_url or prompt.
fit enum optional How the avatar appears in the frame.
remove_background boolean optional Remove the avatar background.
background object optional Solid-color or image background.
type enum required Background type.
value string required Hex color or image HTTP(S) URL.
caption boolean optional Also return an SRT caption file.
output_format enum optional Output video format.
resolution enum optional Output video resolution.
aspect_ratio enum optional Output video aspect ratio.
callback object optional Sends the task object when the task reaches a terminal state.
url string required HTTPS URL that receives terminal notifications.
when enum optional Triggers on terminal status.
Avatar presets (497)
Pass the exact Request value shown on each card in input.avatar.
Show all 497 avatar presets Hide all 497 avatar presets
Request value
Abigail Office Front Request value
Abigail Office Side Request value
Abigail Sofa Front Request value
Abigail Sofa Side Request value
Amelia Business Training Front 2 Request value
Amelia Business Training Front Request value
Amelia Business Training Side 2 Request value
Amelia Business Training Side Request value
Amelia Lounge Front 2 Request value
Amelia Lounge Front Request value
Amelia Lounge Side 2 Request value
Amelia Lounge Side Request value
Amelia Yoga Front 2 Request value
Amelia Yoga Front Request value
Amelia Yoga Side 2 Request value
Amelia Yoga Side Request value
Anja Office Front Request value
Anja Office Side Request value
Anja Sofa Front Request value
Anja Sofa Side Request value
Ann Doctor Sitting Request value
Ann Doctor Standing Request value
Ann Therapist Request value
Annie Bar Sitting Front Request value
Annie Bar Sitting Side Request value
Annie Bar Standing Front 2 Request value
Annie Bar Standing Front 3 Request value
Annie Bar Standing Front Request value
Annie Bar Standing Side 2 Request value
Annie Bar Standing Side 3 Request value
Annie Bar Standing Side Request value
Annie Business Casual Standing Front 2 Request value
Annie Business Casual Standing Front Request value
Annie Business Casual Standing Side 2 Request value
Annie Business Casual Standing Side Request value
Annie Casual Sitting Front 2 Request value
Annie Casual Sitting Front Request value
Annie Casual Sitting Side 2 Request value
Annie Casual Sitting Side Request value
Annie Casual Standing Front 2 Request value
Annie Casual Standing Front Request value
Annie Casual Standing Side 2 Request value
Annie Casual Standing Side Request value
Annie Desk Sitting Front 2 Request value
Annie Desk Sitting Front Request value
Annie Desk Sitting Side 2 Request value
Annie Desk Sitting Side Request value
Annie Lounge Standing Front Request value
Annie Lounge Standing Side Request value
Annie Office Sitting Front 2 Request value
Annie Office Sitting Front Request value
Annie Office Sitting Side 2 Request value
Annie Office Sitting Side Request value
Annie Office Standing Front Request value
Annie Office Standing Side Request value
Annie Sofa Sitting Front 3 Request value
Annie Sofa Sitting Front Request value
Annie Sofa Sitting Side 2 Request value
Annie Sofa Sitting Side 3 Request value
Annie Sofa Sitting Side Request value
Annie Sofa Sitting Front 2 Request value
Annie Studio Pink Sitting Front Request value
Annie Studio Pink Sitting Side Request value
Annie Studio Pink Standing Front Request value
Annie Studio Pink Standing Side Request value
Artur Office Front 2 Request value
Artur Office Front Request value
Artur Office Side 2 Request value
Artur Office Side Request value
Artur Sofa Casual Front 2 Request value
Artur Sofa Casual Front Request value
Artur Sofa Casual Side 2 Request value
Artur Sofa Causal Side Request value
Aubrey Sofa Side Request value
Aubrey Night Scene Front Request value
Aubrey Outdoor Sport Front Request value
Aubrey Outdoor Sport Side Request value
Aubrey Sofa Front Request value
Blanka Lounge Front Request value
Blanka Lounge Side Request value
Blanka Outdoor Business Front Request value
Blanka Outdoor Business Side Request value
Blanka Outdoor Reading Front Request value
Blanka Outdoor Reading Side Request value
Blanka Picnic Front Request value
Blanka Picnic Side Request value
Bojan Business Training Front 2 Request value
Bojan Business Training Front Request value
Bojan Business Training Side 2 Request value
Bojan Business Training Side Request value
Bojan Lounge Front 2 Request value
Bojan Lounge Front Request value
Bojan Lounge Side 2 Request value
Bojan Lounge Side Request value
Bojan Sport Front 2 Request value
Bojan Sport Front Request value
Bojan Sport Side 2 Request value
Bojan Sport Side Request value
Brandon Business Sitting Front Request value
Brandon Business Sitting Side Request value
Brandon Business Standing Front Request value
Brandon Business Standing Side Request value
Brandon Casual Sitting Front Request value
Brandon Casual Sitting Side Request value
Brandon Kitchen Standing Front Request value
Brandon Kitchen Standing Side Request value
Brandon Lobby Sitting Front Request value
Brandon Lobby Sitting Side Request value
Brandon Lobby Standing Front Request value
Brandon Lobby Standing Side Request value
Brandon Office Sitting Front Request value
Brandon Office Sitting Side Request value
Brandon Office Standing Front Request value
Brandon Office Standing Side Request value
Brandon Sofa Sitting Front Request value
Brandon Sofa Sitting Side Request value
Brent Office Front 2 Request value
Brent Office Front Request value
Brent Office Side 2 Request value
Brent Office Side Request value
Brent Sofa Front 2 Request value
Brent Sofa Front Request value
Brent Sofa Side 2 Request value
Brent Sofa Side Request value
Bryan Fitness Coach Request value
Bryan Tech Expert Request value
Caroline Business Sitting Front Request value
Caroline Business Sitting Side Request value
Caroline Business Standing Front Request value
Caroline Business Standing Side Request value
Caroline Casual Sitting Front Request value
Caroline Casual Sitting Side Request value
Caroline Kitchen Standing Front Request value
Caroline Kitchen Standing Side Request value
Caroline Lobby Sitting Front Request value
Caroline Lobby Sitting Side Request value
Caroline Lobby Standing Front Request value
Caroline Lobby Standing Side Request value
Caroline Office Sitting Front Request value
Caroline Office Sitting Side Request value
Caroline Office Standing Front Request value
Caroline Office Standing Side Request value
Caroline Sofa Sitting Front Request value
Caroline Sofa Sitting Side Request value
Chloe Lounge Front Request value
Chloe Lounge Side Request value
Chloe Outdoor Side Request value
Conrad House Front Request value
Conrad House Side Request value
Conrad Sofa Front Request value
Conrad Sofa Side Request value
Derya Indoor Front 2 Request value
Derya Indoor Front Request value
Derya Indoor Side 2 Request value
Derya Indoor Side Request value
Derya Office Front 2 Request value
Derya Office Front Request value
Derya Office Side 2 Request value
Derya Office Side Request value
Dexter Doctor Sitting Request value
Dexter Doctor Standing Request value
Dexter Lawyer Request value
Elenora Fitness Coach Request value
Elenora Fitness Coach 2 Request value
Elenora Tech Expert Request value
Emanuel Office Front Request value
Emanuel Office Side Request value
Emanuel Sofa Front Request value
Emanuel Sofa Side Request value
Emilia Outdoor Business Front Request value
Emilia Outdoor Business Side Request value
Emilia Outdoor Yoga Front 2 Request value
Emilia Outdoor Yoga Front Request value
Emilia Outdoor Yoga Side Request value
Emilia Picnic Front Request value
Emilia Picnic Side Request value
Fernando Business Indoor Front Request value
Fernando Business Indoor Side Request value
Fernando OutdoorChair Front 2 Request value
Fernando Outdoor Chair Front Request value
Fernando Outdoor Chair Side Request value
Fernando Outdoor Front Request value
Fernando Outdoor Side Request value
Fernando Outdoor Table Front Request value
Fernando Outdoor Table Side Request value
Gala Bedroom Front Request value
Gala Business Sofa Front 2 Request value
Gala Business Sofa Front 3 Request value
Gala Business Sofa Front Request value
Gala Business Sofa Side 2 Request value
Gala Business Sofa Side 3 Request value
Gala Business Sofa Side Request value
Gala Casual Sofa with iPad Front Request value
Gala Casual Sofa with iPad Side 2 Request value
Gala Casual Sofa with iPad Side Request value
Gala Office Front Request value
Gala Office Side Request value
Gala Sofa Front 2 Request value
Gala Sofa Front 3 Request value
Gala Sofa Front Request value
Gala Sofa Side 2 Request value
Gala Sofa Side 3 Request value
Gala Sofa Side Request value
Georgia Casual Front Request value
Georgia Casual Side Request value
Georgia Office Front Request value
Georgia Office Side Request value
Gerardo Sofa Side Request value
Gerardo Indoor Front Request value
Gerardo Indoor Side Request value
Gerardo Night Scene Front 2 Request value
Gerardo Night Scene Front Request value
Gerardo Outdoor Sport Front Request value
Gerardo Outdoor Sport Side Request value
Gerardo Sofa Front Request value
Giulia Office Front 2 Request value
Giulia Office Front Request value
Giulia Office Side 2 Request value
Giulia Office Side Request value
Giulia Sofa Front Request value
Giulia Sofa Side Request value
Giulia Sofa Front 2 Request value
Giulia Sofa Side 3 Request value
Ida Lounge Front 2 Request value
Ida Lounge Front Request value
Ida Lounge Side 2 Request value
Ida Lounge Side Request value
Ida Sofa Front 2 Request value
Ida Sofa Front Request value
Ida Sofa Side 2 Request value
Ida Sofa Side Request value
Jocelyn Office Front 2 Request value
Jocelyn Office Front Request value
Jocelyn Office Side 2 Request value
Jocelyn Office Side Request value
Jocelyn Sofa Front 2 Request value
Jocelyn Sofa Front Request value
Jocelyn Sofa Side 2 Request value
Jocelyn Sofa Side Request value
Joel Couch Front Request value
Joel Couch Side Request value
Joel Gym Front Request value
Joel Gym Side Request value
Joel Mountain Front Request value
Joel Mountain Side Request value
Jonas Gym Front 2 Request value
Jonas Gym Front Request value
Jonas Gym Side 2 Request value
Jonas Gym Side Request value
June Office Front 2 Request value
Juan Office Front Request value
Juan Office Side 2 Request value
Juan Office Side Request value
Juan Sofa Front 2 Request value
Juan Sofa Front Request value
Juan Sofa Side 2 Request value
Juan Sofa Side Request value
Judita Yoga Front 2 Request value
Judita Yoga Front Request value
Judita Yoga Side 2 Request value
Judita Yoga Side Request value
Judy Doctor Sitting Request value
Judy Doctor Standing Request value
Judy Lawyer Request value
Judy Teacher Sitting Request value
Judy HR Request value
Judy Teacher Standing Request value
June HR Request value
June Office Front Request value
June Office Side 2 Request value
June Office Side Request value
June Sofa Casual Front 2 Request value
June Sofa Casual Front Request value
June Sofa Casual Side 2 Request value
June Sofa Casual Side Request value
Kavya Indoor Front Request value
Kavya Indoor Side Request value
Kavya Outdoor Side Request value
Kavya Outdoor Sport Front Request value
Kavya Outdoor Sport Side Request value
Kavya Sofa Front Request value
Kavya Sofa Side Request value
Leos Office Front 2 Request value
Leos Office Front Request value
Leos Office Side 2 Request value
Leos Office Side Request value
Leos Sofa Front 2 Request value
Leos Sofa Front Request value
Leos Sofa Side 2 Request value
Leos Sofa Side Request value
Leszek Lounge Front Request value
Leszek Lounge Side Request value
Leszek Outdoor Business Front Request value
Leszek Outdoor Business Side Request value
Leszek Outdoor Casual Front Request value
Leszek Outdoor Casual Side Request value
Leszek Sofa Front Request value
Leszek Sofa Side Request value
Martina Office Front 2 Request value
Martina Office Front Request value
Martina Office Side 2 Request value
Martina Office Side Request value
Martina Sofa Front 2 Request value
Martina Sofa Front Request value
Martina Sofa Side 2 Request value
Martina Sofa Side Request value
Masha Office Front 2 Request value
Masha Office Front Request value
Masha Office Side 2 Request value
Masha Office Side Request value
Masha Sofa Casual Front 2 Request value
Masha Sofa Casual Front Request value
Masha Sofa Casual Side 2 Request value
Masha Sofa Casual Side Request value
Matteo Office Front 2 Request value
Matteo Office Front Request value
Matteo Office Side 2 Request value
Matteo Office Side Request value
Matteo Sofa Front 2 Request value
Matteo Sofa Front Request value
Matteo Sofa Side 2 Request value
Matteo Sofa Side Request value
Max Indoor Front Request value
Max Indoor Side Request value
Max Outdoor Sport Front Request value
Max Outdoor Sport Side Request value
Milena Office Front 2 Request value
Milena Office Front Request value
Milena Office Side 2 Request value
Milena Office Side Request value
Milena Sofa Front 2 Request value
Milena Sofa Front Request value
Milena Sofa Side 2 Request value
Milena Sofa Side Request value
Miles Outdoor Front Request value
Miles Outdoor Side Request value
Miles Sofa Front 2 Request value
Miles Sofa Front Request value
Miles Sofa Side 2 Request value
Miles Sofa Side Request value
Mireia Business Indoor Front Request value
Mireia Business Indoor Side Request value
Mireia Outdoor Chair Front Request value
Mireia Outdoor Front Request value
Mireia Outdoor Side Request value
Mireia Outdoor Table Front Request value
Mireia Outdoor Table Side Request value
Miyu Office Front 2 Request value
Miyu Office Front Request value
Miyu Office Side 2 Request value
Miyu Office Side Request value
Miyu Sofa Business Front Request value
Miyu Sofa Business Side Request value
Miyu Sofa Casual Front 2 Request value
Miyu Sofa Casual Front Request value
Miyu Sofa Casual Side 2 Request value
Miyu Sofa Casual Side Request value
Noah Lobby Front 2 Request value
Noah Lobby Front Request value
Noah Lobby Side 2 Request value
Noah Lobby Side Request value
Noah Office Front 2 Request value
Noah Office Front Request value
Noah Office Side 2 Request value
Noah Office Side Request value
Noah Sofa Front 2 Request value
Noah Sofa Front Request value
Noah Sofa Side 2 Request value
Noah Sofa Side Request value
Oxana Gym Front 2 Request value
Oxana Gym Front Request value
Oxana Gym Side 2 Request value
Oxana Gym Side Request value
Oxana Office Front 2 Request value
Oxana Office Front Request value
Oxana Office Side 2 Request value
Oxana Office Side Request value
Oxana Sofa Front 2 Request value
Oxana Sofa Front Request value
Oxana Sofa Side 2 Request value
Oxana Sofa Side Request value
Oxana Yoga Front 2 Request value
Oxana Yoga Front Request value
Oxana Yoga Side 2 Request value
Oxana Yoga Side Request value
Patrizio Business Training Front Request value
Patrizio Business Training Side Request value
Patrizio Office Front Request value
Patrizio Office Side 2 Request value
Patrizio Office Side Request value
Patrizio Sofa Front Request value
Patrizio Sofa Side Request value
Piper Business Sofa Front Request value
Piper Business Sofa Side Request value
Piper Education Front Request value
Piper Education Side Request value
Rasmus Lounge Front 2 Request value
Rasmus Lounge Front Request value
Rasmus Lounge Side 2 Request value
Rasmus Lounge Side Request value
Rasmus Sofa Front 2 Request value
Rasmus Sofa Front Request value
Rasmus Sofa Side 2 Request value
Rasmus Sofa Side Request value
Raul Business Sofa Front 2 Request value
Raul Business Sofa Front Request value
Raul Business Sofa Side 2 Request value
Raul Business Sofa Side Request value
Raul Casual Sofa Front 2 Request value
Raul Casual Sofa Front Request value
Raul Casual Sofa Side 2 Request value
Raul Casual Sofa Side Request value
Raul Casual Sofa no iPad Front Request value
Raul Casual Sofa no iPad Side Request value
Raul Casual Sofa with iPad Front Request value
Raul Casual Sofa with iPad Side Request value
Raul Office Front 2 Request value
Raul Office Front Request value
Raul Office Side Request value
Raul Sofa Front 2 Request value
Raul Sofa Front Request value
Raul Sofa Side 2 Request value
Raul Sofa Side Request value
Ren Office Front 2 Request value
Ren Office Front Request value
Ren Office Side 2 Request value
Ren Office Side Request value
Ren Sofa Business Front Request value
Ren Sofa Business Side Request value
Ren Sofa Casual Front 2 Request value
Ren Sofa Casual Front Request value
Ren Sofa Casual Side 2 Request value
Ren Sofa Casual Side Request value
Riley Casual Front Request value
Riley Casual Side Request value
Riley Office Front Request value
Riley Office Side Request value
Roman Outdoor Sport Front Request value
Roman Outdoor Sport Side Request value
Sabine Office Front 2 Request value
Sabine Office Front Request value
Sabine Office Side Request value
Sabine Sofa Side Request value
Santa Fireplace Front Request value
Santa Fireplace Side Request value
Scarlett Couch Front 2 Request value
Scarlett Couch Front Request value
Scarlett Couch Side 2 Request value
Scarlett Couch Side Request value
Scarlett Fireplace Front Request value
Scarlett Fireplace Side Request value
Scarlett Hall Front Request value
Scarlett Hall Side Request value
Scarlett Yoga Front Request value
Scarlett Yoga Side Request value
Shawn Therapist Request value
Silas Customer Support Request value
Silas HR Request value
Silas Lounge Front Request value
Silas Lounge Side Request value
Silas Sofa Side 2 Request value
Silas Sofa Side Request value
Teodor Office Front 2 Request value
Teodor Office Front Request value
Teodor Office Side 2 Request value
Teodor Office Side Request value
Teodor Sofa Front 2 Request value
Teodor Sofa Front Request value
Teodor Sofa Side 2 Request value
Teodor Sofa Side Request value
Timothy Casual Front Request value
Timothy Casual Side Request value
Timothy Office Front Request value
Timothy Office Side Request value
Veit Office Front Request value
Veit Office Side Request value
Veit Sofa Front Request value
Veit Sofa Side Request value
Vernon Office Front 2 Request value
Vernon Office Front Request value
Vernon Office Side 2 Request value
Vernon Office Side Request value
Verena Office Front Request value
Verena Office Side Request value
Verena Sofa Front Request value
Verena Sofa Side Request value
Vernon Lounge Front 2 Request value
Vernon Lounge Side 2 Request value
Vernon Lounge Side Request value
Vince Business Sofa Front Request value
Vince Business Training Front Request value
Vince Business Training Side 2 Request value
Vince Business Training Side Request value
Vince Sofa Casual Front 2 Request value
Vince Sofa Casual Front Request value
Vince Sofa Casual Side 2 Request value
Vince Sofa Casual Side No matching avatar values
Voice presets (102)
Pass the exact Request value shown on each card in input.voice.
Show all 102 voice presets Hide all 102 voice presets
Request value
Warm Pro Narrator Request value
Chill Brian Request value
Ivy Request value
John Doe Request value
Monika Sogam Request value
Hope Request value
Archer Request value
Brittney Request value
Patrick Request value
David Castlemore Request value
Michael C Request value
Adam Stone Request value
Juniper Request value
Cassidy Request value
Jessica Anne Bogart Request value
Arabella Request value
Andrew Request value
Spuds Oxley Request value
Grace Elder Request value
Helen Request value
Canyon Rivers Request value
Derya - Lifelike - Excited Request value
Mellow Marcus Request value
Jack Sterling - Broadcaster Request value
Brenda - UGC - 1.mp4 Request value
Reid Request value
Reagan Request value
Terry Request value
Jenny Request value
Radio Rick Request value
Denise Request value
Tim in car - Excited Request value
Iskander Request value
Thompson Request value
Delicate Daisy - Excited Request value
Kingston Request value
George UGC 1 Request value
Bold Blake Request value
Jane Request value
Expressive Evan Request value
Marianne - IA Request value
Aaron Request value
Modern Recipe Host - Voice 1 Request value
Willow Request value
Cute Chloe - Friendly Request value
Rafael Request value
June - Lifelike Request value
Crisp Chloe Request value
Slick Simon Request value
Nassim - Informative Request value
Baritone Ben Request value
Maxwell Request value
Ellie Faye - Excited Request value
Milani Request value
Feisty Fiona - Excited Request value
Professor Dean Request value
Rose - UGC - 1.mp4 Request value
Shona Request value
Hudson Wilder Request value
Ann - IA Request value
Alastair Kensington Request value
Oxley Request value
Christina Request value
Andrew Rizz Request value
Peyton Request value
Gerardo - Outdoor Request value
Chloe - Lifelike Request value
Stephanie Request value
Anthony - IA Request value
Signal - Voice 1 Request value
Luca Request value
Lisa - Voice 1 Request value
T.W.Tucker Request value
Jack Sullivan - Serious Request value
Winter Request value
Mireia - Lifelike Request value
Georgia Request value
Stella Request value
Masha - Lifelike Request value
Charming Charles - Friendly Request value
Serenity Request value
Annie - Excited Request value
Ralph Request value
Bethany Request value
Dominic Request value
Mason Finn Request value
Leena Request value
Veteran Victor Request value
Tamara Request value
Nik Public Request value
Calm Chloe Request value
Sevik Request value
Reilly Request value
Raul Request value
Imposing Ian Request value
Relaxed Ray Request value
Dexter - Professional Request value
Relaxed Rick Request value
Edwin Request value
Rupert Blackwood Request value
Ginny Request value
Hope No matching voice values
Example requests
Script and SRT captions
Generate video with a preset voice and return an SRT file.
Request body
{
"model": "heygen-avatar-v",
"input": {
"avatar": "Abigail Sofa Front",
"prompt": "Welcome to our avatar video service.",
"voice": "Warm Pro Narrator",
"caption": true,
"resolution": "720p",
"aspect_ratio": "16:9"
}
}Driving audio
Drive lip-sync directly from an existing audio file.
Request body
{
"model": "heygen-avatar-v",
"input": {
"avatar": "Abigail Sofa Front",
"audio_url": "https://example.com/voice.mp3",
"caption": false,
"resolution": "1080p",
"aspect_ratio": "9:16"
}
}Getting the result
- Read data.taskId after creating the task.
- Wait for the callback or query GET /v1/tasks/:id.
- On status=success, read the video from output type=video and, when enabled, the SRT file from output type=caption.