Heygen Avatar V
heygen-avatar-v
heygen-avatar-v
Try heygen-avatar-v
Input
Output
Fill in the parameters and run — results show up here.
Pricing
heygen-avatar-v per second
| Unit Price | $0.150 |
|---|
Introduction coming soon
A detailed guide for this model is being prepared. Pricing, parameters and the API docs below are already available.
Create a generation task
POST
https://api.hiapi.ai/v1/tasks Headers
AuthorizationstringRequiredAccount API key. Required on every request. Example: Bearer YOUR_HIAPI_API_KEY. Get your API key
Content-TypestringOptionalThe request body is always parsed as JSON; when sent, only application/json (optionally with charset) is accepted — any other value returns 415. Example: application/json.
Idempotency-KeystringOptionalIdempotency key, up to 255 bytes. Retries with the same key from the same account create the task only once; replays return the original taskId.
Idempotency key
On network timeouts or client retries, the same key creates the task only once — no double charges (scope: the API key's account). Use a business-unique identifier as the key (e.g. "order-42"); replays return the original taskId, and keys expire 24 hours after the first request. See the Unified Async API overview for the full scenario matrix.
Body
modelstringRequiredCurrent fixed value: heygen-avatar-v
routestringOptionalCurrent fixed value: default
inputobjectRequired
Business parameters for heygen-avatar-v and route default — see the parameter table below.
fitstringOptionalDefault: "cover"Options:
containcovervoicestringOptionalDefault: "Warm Pro Narrator"minLength 1Text-to-speech voice name. Ignored when audio_url is present.
Options:
Warm Pro NarratorChill BrianIvyJohn DoeMonika SogamHope Archer BrittneyShow all (94)
PatrickDavid CastlemoreMichael CAdam Stone JuniperCassidy Jessica Anne BogartArabellaAndrewSpuds Oxley Grace ElderHelenCanyon RiversDerya - Lifelike - ExcitedMellow MarcusJack Sterling - BroadcasterBrenda - UGC - 1.mp4ReidReaganTerryJennyRadio RickDeniseTim in car - ExcitedIskanderThompsonDelicate Daisy - ExcitedKingstonGeorge UGC 1Bold BlakeJaneExpressive EvanMarianne - IAAaronModern Recipe Host - Voice 1WillowCute Chloe - FriendlyRafaelJune - LifelikeCrisp ChloeSlick SimonNassim - InformativeBaritone BenMaxwellEllie Faye - ExcitedMilaniFeisty Fiona - ExcitedProfessor DeanRose - UGC - 1.mp4ShonaHudson WilderAnn - IAAlastair KensingtonOxleyChristinaAndrew Rizz PeytonGerardo - OutdoorChloe - LifelikeStephanieAnthony - IASignal - Voice 1LucaLisa - Voice 1T.W.TuckerJack Sullivan - SeriousWinterMireia - LifelikeGeorgiaStellaMasha - LifelikeCharming Charles - FriendlySerenityAnnie - ExcitedRalphBethanyDominicMason FinnLeenaVeteran VictorTamaraNik PublicCalm ChloeSevikReillyRaulImposing IanRelaxed RayDexter - ProfessionalRelaxed RickEdwinRupert BlackwoodGinnyHopeavatarstringOptionalDefault: "Abigail Sofa Front"minLength 1Avatar V preset name.
Options:
Abigail Office FrontAbigail Office SideAbigail Sofa FrontAbigail Sofa SideAmelia Business Training Front 2Amelia Business Training FrontAmelia Business Training Side 2Amelia Business Training SideShow all (489)
Amelia Lounge Front 2Amelia Lounge FrontAmelia Lounge Side 2Amelia Lounge SideAmelia Yoga Front 2Amelia Yoga FrontAmelia Yoga Side 2Amelia Yoga SideAnja Office FrontAnja Office Side Anja Sofa FrontAnja Sofa Side Ann Doctor SittingAnn Doctor StandingAnn TherapistAnnie Bar Sitting FrontAnnie Bar Sitting SideAnnie Bar Standing Front 2Annie Bar Standing Front 3Annie Bar Standing FrontAnnie Bar Standing Side 2Annie Bar Standing Side 3Annie Bar Standing SideAnnie Business Casual Standing Front 2Annie Business Casual Standing FrontAnnie Business Casual Standing Side 2Annie Business Casual Standing SideAnnie Casual Sitting Front 2Annie Casual Sitting FrontAnnie Casual Sitting Side 2Annie Casual Sitting SideAnnie Casual Standing Front 2Annie Casual Standing FrontAnnie Casual Standing Side 2Annie Casual Standing SideAnnie Desk Sitting Front 2Annie Desk Sitting FrontAnnie Desk Sitting Side 2Annie Desk Sitting SideAnnie Lounge Standing FrontAnnie Lounge Standing SideAnnie Office Sitting Front 2Annie Office Sitting FrontAnnie Office Sitting Side 2Annie Office Sitting SideAnnie Office Standing FrontAnnie Office Standing SideAnnie Sofa Sitting Front 3Annie Sofa Sitting FrontAnnie Sofa Sitting Side 2Annie Sofa Sitting Side 3Annie Sofa Sitting SideAnnie Sofa Sitting Front 2Annie Studio Pink Sitting FrontAnnie Studio Pink Sitting SideAnnie Studio Pink Standing FrontAnnie Studio Pink Standing SideArtur Office Front 2Artur Office FrontArtur Office Side 2Artur Office SideArtur Sofa Casual Front 2Artur Sofa Casual FrontArtur Sofa Casual Side 2Artur Sofa Causal SideAubrey Sofa SideAubrey Night Scene FrontAubrey Outdoor Sport FrontAubrey Outdoor Sport SideAubrey Sofa FrontBlanka Lounge FrontBlanka Lounge SideBlanka Outdoor Business FrontBlanka Outdoor Business SideBlanka Outdoor Reading FrontBlanka Outdoor Reading SideBlanka Picnic FrontBlanka Picnic SideBojan Business Training Front 2Bojan Business Training FrontBojan Business Training Side 2Bojan Business Training SideBojan Lounge Front 2Bojan Lounge FrontBojan Lounge Side 2Bojan Lounge SideBojan Sport Front 2Bojan Sport FrontBojan Sport Side 2Bojan Sport SideBrandon Business Sitting FrontBrandon Business Sitting SideBrandon Business Standing FrontBrandon Business Standing SideBrandon Casual Sitting FrontBrandon Casual Sitting SideBrandon Kitchen Standing FrontBrandon Kitchen Standing SideBrandon Lobby Sitting FrontBrandon Lobby Sitting SideBrandon Lobby Standing FrontBrandon Lobby Standing SideBrandon Office Sitting FrontBrandon Office Sitting SideBrandon Office Standing FrontBrandon Office Standing SideBrandon Sofa Sitting FrontBrandon Sofa Sitting SideBrent Office Front 2Brent Office FrontBrent Office Side 2Brent Office SideBrent Sofa Front 2Brent Sofa FrontBrent Sofa Side 2Brent Sofa SideBryan Fitness CoachBryan Tech ExpertCaroline Business Sitting FrontCaroline Business Sitting SideCaroline Business Standing FrontCaroline Business Standing SideCaroline Casual Sitting FrontCaroline Casual Sitting SideCaroline Kitchen Standing FrontCaroline Kitchen Standing SideCaroline Lobby Sitting FrontCaroline Lobby Sitting SideCaroline Lobby Standing FrontCaroline Lobby Standing SideCaroline Office Sitting FrontCaroline Office Sitting SideCaroline Office Standing FrontCaroline Office Standing SideCaroline Sofa Sitting FrontCaroline Sofa Sitting SideChloe Lounge FrontChloe Lounge SideChloe Outdoor SideConrad House FrontConrad House SideConrad Sofa FrontConrad Sofa SideDerya Indoor Front 2Derya Indoor FrontDerya Indoor Side 2Derya Indoor SideDerya Office Front 2Derya Office FrontDerya Office Side 2Derya Office SideDexter Doctor SittingDexter Doctor StandingDexter LawyerElenora Fitness CoachElenora Fitness Coach 2Elenora Tech ExpertEmanuel Office FrontEmanuel Office SideEmanuel Sofa FrontEmanuel Sofa SideEmilia Outdoor Business FrontEmilia Outdoor Business SideEmilia Outdoor Yoga Front 2Emilia Outdoor Yoga FrontEmilia Outdoor Yoga SideEmilia Picnic FrontEmilia Picnic SideFernando Business Indoor FrontFernando Business Indoor SideFernando OutdoorChair Front 2Fernando Outdoor Chair FrontFernando Outdoor Chair SideFernando Outdoor FrontFernando Outdoor SideFernando Outdoor Table FrontFernando Outdoor Table SideGala Bedroom FrontGala Business Sofa Front 2Gala Business Sofa Front 3Gala Business Sofa FrontGala Business Sofa Side 2Gala Business Sofa Side 3Gala Business Sofa SideGala Casual Sofa with iPad FrontGala Casual Sofa with iPad Side 2Gala Casual Sofa with iPad SideGala Office FrontGala Office SideGala Sofa Front 2Gala Sofa Front 3Gala Sofa FrontGala Sofa Side 2Gala Sofa Side 3Gala Sofa SideGeorgia Casual FrontGeorgia Casual SideGeorgia Office FrontGeorgia Office SideGerardo Sofa SideGerardo Indoor FrontGerardo Indoor SideGerardo Night Scene Front 2Gerardo Night Scene FrontGerardo Outdoor Sport FrontGerardo Outdoor Sport SideGerardo Sofa FrontGiulia Office Front 2Giulia Office FrontGiulia Office Side 2Giulia Office SideGiulia Sofa FrontGiulia Sofa SideGiulia Sofa Front 2Giulia Sofa Side 3Ida Lounge Front 2Ida Lounge FrontIda Lounge Side 2Ida Lounge SideIda Sofa Front 2Ida Sofa FrontIda Sofa Side 2Ida Sofa SideJocelyn Office Front 2Jocelyn Office FrontJocelyn Office Side 2Jocelyn Office SideJocelyn Sofa Front 2Jocelyn Sofa FrontJocelyn Sofa Side 2Jocelyn Sofa SideJoel Couch FrontJoel Couch SideJoel Gym FrontJoel Gym SideJoel Mountain FrontJoel Mountain SideJonas Gym Front 2Jonas Gym FrontJonas Gym Side 2Jonas Gym Side June Office Front 2Juan Office FrontJuan Office Side 2Juan Office SideJuan Sofa Front 2Juan Sofa FrontJuan Sofa Side 2Juan Sofa SideJudita Yoga Front 2Judita Yoga FrontJudita Yoga Side 2Judita Yoga SideJudy Doctor SittingJudy Doctor StandingJudy LawyerJudy Teacher SittingJudy HRJudy Teacher StandingJune HRJune Office FrontJune Office Side 2June Office SideJune Sofa Casual Front 2June Sofa Casual FrontJune Sofa Casual Side 2June Sofa Casual SideKavya Indoor FrontKavya Indoor SideKavya Outdoor SideKavya Outdoor Sport FrontKavya Outdoor Sport SideKavya Sofa FrontKavya Sofa SideLeos Office Front 2Leos Office FrontLeos Office Side 2Leos Office SideLeos Sofa Front 2Leos Sofa FrontLeos Sofa Side 2Leos Sofa SideLeszek Lounge FrontLeszek Lounge SideLeszek Outdoor Business FrontLeszek Outdoor Business SideLeszek Outdoor Casual FrontLeszek Outdoor Casual SideLeszek Sofa FrontLeszek Sofa SideMartina Office Front 2Martina Office FrontMartina Office Side 2Martina Office SideMartina Sofa Front 2Martina Sofa FrontMartina Sofa Side 2Martina Sofa SideMasha Office Front 2Masha Office FrontMasha Office Side 2Masha Office SideMasha Sofa Casual Front 2Masha Sofa Casual FrontMasha Sofa Casual Side 2Masha Sofa Casual SideMatteo Office Front 2Matteo Office FrontMatteo Office Side 2Matteo Office SideMatteo Sofa Front 2Matteo Sofa FrontMatteo Sofa Side 2Matteo Sofa SideMax Indoor FrontMax Indoor SideMax Outdoor Sport FrontMax Outdoor Sport SideMilena Office Front 2Milena Office FrontMilena Office Side 2Milena Office SideMilena Sofa Front 2Milena Sofa FrontMilena Sofa Side 2Milena Sofa SideMiles Outdoor FrontMiles Outdoor SideMiles Sofa Front 2Miles Sofa FrontMiles Sofa Side 2Miles Sofa SideMireia Business Indoor FrontMireia Business Indoor SideMireia Outdoor Chair FrontMireia Outdoor FrontMireia Outdoor SideMireia Outdoor Table FrontMireia Outdoor Table SideMiyu Office Front 2Miyu Office FrontMiyu Office Side 2Miyu Office SideMiyu Sofa Business FrontMiyu Sofa Business SideMiyu Sofa Casual Front 2Miyu Sofa Casual FrontMiyu Sofa Casual Side 2 Miyu Sofa Casual SideNoah Lobby Front 2Noah Lobby FrontNoah Lobby Side 2Noah Lobby SideNoah Office Front 2Noah Office FrontNoah Office Side 2Noah Office SideNoah Sofa Front 2Noah Sofa Front Noah Sofa Side 2Noah Sofa SideOxana Gym Front 2Oxana Gym FrontOxana Gym Side 2Oxana Gym SideOxana Office Front 2Oxana Office FrontOxana Office Side 2Oxana Office SideOxana Sofa Front 2Oxana Sofa FrontOxana Sofa Side 2Oxana Sofa SideOxana Yoga Front 2Oxana Yoga FrontOxana Yoga Side 2Oxana Yoga SidePatrizio Business Training FrontPatrizio Business Training SidePatrizio Office FrontPatrizio Office Side 2Patrizio Office SidePatrizio Sofa FrontPatrizio Sofa SidePiper Business Sofa FrontPiper Business Sofa SidePiper Education FrontPiper Education SideRasmus Lounge Front 2Rasmus Lounge FrontRasmus Lounge Side 2Rasmus Lounge SideRasmus Sofa Front 2Rasmus Sofa FrontRasmus Sofa Side 2Rasmus Sofa SideRaul Business Sofa Front 2Raul Business Sofa FrontRaul Business Sofa Side 2Raul Business Sofa SideRaul Casual Sofa Front 2Raul Casual Sofa FrontRaul Casual Sofa Side 2Raul Casual Sofa SideRaul Casual Sofa no iPad FrontRaul Casual Sofa no iPad SideRaul Casual Sofa with iPad FrontRaul Casual Sofa with iPad SideRaul Office Front 2Raul Office FrontRaul Office SideRaul Sofa Front 2Raul Sofa FrontRaul Sofa Side 2Raul Sofa SideRen Office Front 2Ren Office FrontRen Office Side 2Ren Office SideRen Sofa Business FrontRen Sofa Business SideRen Sofa Casual Front 2Ren Sofa Casual FrontRen Sofa Casual Side 2 Ren Sofa Casual SideRiley Casual FrontRiley Casual SideRiley Office FrontRiley Office SideRoman Outdoor Sport FrontRoman Outdoor Sport SideSabine Office Front 2Sabine Office FrontSabine Office SideSabine Sofa SideSanta Fireplace FrontSanta Fireplace SideScarlett Couch Front 2Scarlett Couch FrontScarlett Couch Side 2Scarlett Couch SideScarlett Fireplace FrontScarlett Fireplace SideScarlett Hall FrontScarlett Hall SideScarlett Yoga FrontScarlett Yoga SideShawn TherapistSilas Customer SupportSilas HRSilas Lounge FrontSilas Lounge SideSilas Sofa Side 2Silas Sofa SideTeodor Office Front 2Teodor Office FrontTeodor Office Side 2Teodor Office SideTeodor Sofa Front 2Teodor Sofa FrontTeodor Sofa Side 2Teodor Sofa SideTimothy Casual FrontTimothy Casual SideTimothy Office FrontTimothy Office SideVeit Office FrontVeit Office SideVeit Sofa FrontVeit Sofa SideVernon Office Front 2Vernon Office FrontVernon Office Side 2Vernon Office SideVerena Office FrontVerena Office SideVerena Sofa FrontVerena Sofa SideVernon Lounge Front 2Vernon Lounge Side 2Vernon Lounge SideVince Business Sofa FrontVince Business Training FrontVince Business Training Side 2Vince Business Training SideVince Sofa Casual Front 2Vince Sofa Casual FrontVince Sofa Casual Side 2Vince Sofa Casual SidepromptstringOptionalminLength 1maxLength 5000Text the avatar will speak. Required when audio_url is absent.
captionbooleanOptionalDefault: falseReturn a sidecar SRT caption file.
audio_urlstringOptionalpattern ^https://HTTPS audio URL for lip-sync, at most 600 seconds. When present, prompt and voice are ignored.
backgroundobjectOptional
typestringRequiredOptions:
colorimagevaluestringRequiredminLength 1resolutionstringOptionalDefault: "720p"Options:
720p1080p4kaspect_ratiostringOptionalDefault: "16:9"Options:
16:99:164:55:41:1autooutput_formatstringOptionalDefault: "mp4"Options:
mp4webmremove_backgroundbooleanOptionalDefault: falsecallbackobjectOptional
Terminal-state notification config. When omitted, no callback is delivered — poll the task yourself. See the callback note below.
Callbacks (Webhook)
Provide callback.url when creating a task and HiAPI POSTs to your service once the task reaches a terminal state — no polling needed. The callback payload mirrors the task detail structure; signature verification, delivery retries and idempotency are documented on the Unified Async API overview page.
urlstringRequiredRequired when callback is present. A POST is sent to this URL once the task reaches a terminal state; must be a valid http(s) URL.
whenstringOptionalDefault: "final"Only final is supported today — notified on both success and fail.
Options:
finalstoragestringOptionalDefault: "temp"Artifact storage tier: temp (default, retained about 7 days) or persistent (long-term, billed by size). Insufficient balance or exceeding the storage cap silently downgrades to temp; the effective tier is shown in the task detail response.
Options:
temppersistentRequest examples
# Submit an async task; returns a taskId immediately (no waiting for generation)
curl -X POST "https://api.hiapi.ai/v1/tasks" \
-H "Authorization: Bearer $HIAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "heygen-avatar-v",
"input": {
"fit": "cover",
"voice": "Warm Pro Narrator",
"avatar": "Abigail Sofa Front",
"caption": false,
"resolution": "720p",
"aspect_ratio": "16:9",
"output_format": "mp4",
"remove_background": false
}
}'const res = await fetch("https://api.hiapi.ai/v1/tasks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.HIAPI_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
model: "heygen-avatar-v",
input: {
"fit": "cover",
"voice": "Warm Pro Narrator",
"avatar": "Abigail Sofa Front",
"caption": false,
"resolution": "720p",
"aspect_ratio": "16:9",
"output_format": "mp4",
"remove_background": false
}
}),
});
const task = await res.json();
// { code: 200, message: "success", data: { taskId } }import os, requests
res = requests.post(
"https://api.hiapi.ai/v1/tasks",
headers={"Authorization": f"Bearer {os.environ['HIAPI_API_KEY']}"},
json={
"model": "heygen-avatar-v",
"input": {
"fit": "cover",
"voice": "Warm Pro Narrator",
"avatar": "Abigail Sofa Front",
"caption": false,
"resolution": "720p",
"aspect_ratio": "16:9",
"output_format": "mp4",
"remove_background": false
}
},
)
print(res.json()) # { code, message, data: { taskId } }200 OK
{
"code": 200,
"message": "success",
"data": {
"taskId": "tk-hiapi-01HZTQ8BX2N3GM3YFK4Z9D7VQR"
}
}400 Bad Request
{
"code": 400,
"message": "invalid request",
"data": null,
"error_code": "INVALID_REQUEST"
}Get task detail
GET
https://api.hiapi.ai/v1/tasks/:id Response fields
taskIdstringRequiredTask ID, always prefixed with tk-hiapi-.
modelstringRequiredResolved full model name. Tasks submitted with the route parameter return base@route (e.g. gpt-image-2/text-to-image@ext); otherwise identical to the name passed at creation.
routestringOptionalPresent only when the task was submitted with an explicit route parameter; echoes the submitted value.
statusstringRequiredTask status.
Status values
queued Queued, not started yet.
handling Being processed.
archiving Processing finished, artifacts being prepared.
success Terminal: completed, artifacts available (output returned).
fail Terminal: failed (error returned).
After submission, check status: success and fail are terminal, everything else is non-terminal. Poll every 1–3 seconds until terminal. On success, download artifacts from output[].url and transfer them before expireAt; pass storage: "persistent" at creation time when long-term retention is needed.
creatednumberRequiredTask creation time (Unix seconds).
completednumberRequiredUnix seconds when the task reached a terminal state; fixed to 0 while not terminal.
outputarrayOptional
Present only when status == success. Artifact list — always an array; a single task may return multiple types at once (e.g. video + first_frame).
Array [ object ]
Array items
urlstringRequiredArtifact URL, directly downloadable.
typestringRequiredCurrent possible values: video, image, audio, first_frame, last_frame, thumbnail; more may be added later.
expireAtnumberRequiredUnix seconds until which the artifact remains accessible; download or transfer before it expires.
errorobjectOptional
Present only when status == fail.
codestringRequiredBusiness error code.
messagestringRequiredError description.
Response examples
Success
{
"code": 200,
"message": "success",
"data": {
"taskId": "tk-hiapi-01HZTQ8BX2N3GM3YFK4Z9D7VQR",
"model": "happyhorse-1-0",
"status": "success",
"created": 1777282033,
"completed": 1777282099,
"output": [
{
"url": "https://cdn.hiapi.ai/tasks/.../video.mp4",
"type": "video",
"expireAt": 1777886899
}
]
}
}Processing (non-terminal)
{
"code": 200,
"message": "success",
"data": {
"taskId": "tk-hiapi-...",
"model": "happyhorse-1-0",
"status": "archiving",
"created": 1777282033,
"completed": 0
}
}Failed
{
"code": 200,
"message": "success",
"data": {
"taskId": "tk-hiapi-...",
"model": "happyhorse-1-0",
"status": "fail",
"created": 1777282033,
"completed": 1777282099,
"error": {
"code": "TASK_FAILED",
"message": "task failed"
}
}
}