# heygen/avatar-v > HeyGen Avatar V creates high-quality talking-avatar videos from a selected avatar and speech audio, with optional backgrounds and up to 4K output for presentations, training videos, product introductions, marketing content, and digital human workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing. ## Overview - **Endpoint**: `https://api.wavespeed.ai/api/v3/heygen/avatar-v` - **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result` - **Model ID**: `heygen/avatar-v` - **Category**: digital-human ## API Information This model can be used via our HTTP API or more conveniently via our client libraries. The API is asynchronous: submit a prediction, then poll its result URL until it completes. ### Input Schema The API accepts the following input parameters: - **`avatar`** (`string`, _required_): Select an available avatar ID. - Options: "Abigail_sitting_sofa_front", "Abigail_sitting_sofa_side", "Abigail_standing_office_front", "Abigail_standing_office_side", "Amelia_lying_lounge_front", "Amelia_lying_lounge_side", "Amelia_sitting_business_training_front", "Amelia_sitting_business_training_side", "Amelia_sitting_yoga_front", "Amelia_sitting_yoga_side", "Amelia_standing_business_training_front", "Amelia_standing_business_training_side", "Amelia_standing_lounge_front", "Amelia_standing_lounge_side", "Amelia_standing_yoga_front", "Amelia_standing_yoga_side", "Anja_sitting_sofa_front", "Anja_sitting_sofa_side", "Anja_standing_office_front", "Anja_standing_office_side", "Ann_Doctor_Sitting_public", "Ann_Doctor_Standing2_public", "Ann_Therapist_public", "Annie_Bar_Sitting_Front_public", "Annie_Bar_Sitting_Side_public", "Annie_Bar_Standing_Front_2_public", "Annie_Bar_Standing_Front_3_public", "Annie_Bar_Standing_Front_public", "Annie_Bar_Standing_Side_2_public", "Annie_Bar_Standing_Side_3_public", "Annie_Bar_Standing_Side_public", "Annie_Business_Casual_Standing_Front_2_public", "Annie_Business_Casual_Standing_Front_public", "Annie_Business_Casual_Standing_Side_2_public", "Annie_Business_Casual_Standing_Side_public", "Annie_Casual_Sitting_Front_2_public", "Annie_Casual_Sitting_Front_public", "Annie_Casual_Sitting_Side_2_public", "Annie_Casual_Sitting_Side_public", "Annie_Casual_Standing_Front_2_public", "Annie_Casual_Standing_Front_public", "Annie_Casual_Standing_Side_2_public", "Annie_Casual_Standing_Side_public", "Annie_Desk_Sitting_Front_2_public", "Annie_Desk_Sitting_Front_public", "Annie_Desk_Sitting_Side_2_public", "Annie_Desk_Sitting_Side_public", "Annie_Lounge_Standing_Front_public", "Annie_Lounge_Standing_Side_public", "Annie_Office_Sitting_Front_2_public", "Annie_Office_Sitting_Front_public", "Annie_Office_Sitting_Side_2_public", "Annie_Office_Sitting_Side_public", "Annie_Office_Standing_Front_public", "Annie_Office_Standing_Side_public", "Annie_Sofa_Sitting_Front_3_public", "Annie_Sofa_Sitting_Front_public", "Annie_Sofa_Sitting_Side1_public", "Annie_Sofa_Sitting_Side_2_public", "Annie_Sofa_Sitting_Side_3_public", "Annie_Sofa_Sitting_Side_public", "Annie_Studio_Pink_Sitting_Front_public", "Annie_Studio_Pink_Sitting_Side_public", "Annie_Studio_Pink_Standing_Front_public", "Annie_Studio_Pink_Standing_Side_public", "Artur_sitting_office_front", "Artur_sitting_office_side", "Artur_sitting_sofacasual_front", "Artur_sitting_sofacasual_side", "Artur_standing_office_front", "Artur_standing_office_side", "Artur_standing_sofacasual_front", "Artur_standing_sofacasual_side", "Aubrey_sitting_sofa_front", "Aubrey_sitting_sofa_side", "Aubrey_standing_night_scene_front", "Aubrey_standing_outdoor_sport_front", "Aubrey_standing_outdoor_sport_side", "Blanka_lying_outfoorreading_front", "Blanka_lying_outfoorreading_side", "Blanka_sitting_lounge_front", "Blanka_sitting_lounge_side", "Blanka_sitting_picnic_front", "Blanka_sitting_picnic_side", "Blanka_standing_outfoorbusiness_front", "Blanka_standing_outfoorbusiness_side", "Bojan_lying_lounge_front", "Bojan_lying_lounge_side", "Bojan_sitting_businesstraining_front", "Bojan_sitting_businesstraining_side", "Bojan_sitting_sport_front", "Bojan_sitting_sport_side", "Bojan_standing_businesstraining_front", "Bojan_standing_businesstraining_side", "Bojan_standing_lounge_front", "Bojan_standing_lounge_side", "Bojan_standing_sport_front", "Bojan_standing_sport_side", "Brandon_Business_Sitting_Front_public", "Brandon_Business_Sitting_Side_public", "Brandon_Business_Standing_Front_public", "Brandon_Business_Standing_Side_public", "Brandon_Casual_Sitting_Front_public", "Brandon_Casual_Sitting_Side_public", "Brandon_Kitchen_Standing_Front_public", "Brandon_Kitchen_Standing_Side_public", "Brandon_Lobby_Sitting_Front_public", "Brandon_Lobby_Sitting_Side_public", "Brandon_Lobby_Standing_Front_public", "Brandon_Lobby_Standing_Side_public", "Brandon_Office_Sitting_Front_public", "Brandon_Office_Sitting_Side_public", "Brandon_Office_Standing_Front_public", "Brandon_Office_Standing_Side_public", "Brandon_Sofa_Sitting_Front_public", "Brandon_Sofa_Sitting_Side_public", "Brent_sitting_office_front", "Brent_sitting_office_side", "Brent_sitting_sofa_front", "Brent_sitting_sofa_side", "Brent_standing_office_front", "Brent_standing_office_side", "Brent_standing_sofa_front", "Brent_standing_sofa_side", "Bryan_FitnessCoach_public", "Bryan_IT_Sitting_public", "Caroline_Business_Sitting_Front_public", "Caroline_Business_Sitting_Side_public", "Caroline_Business_Standing_Front_public", "Caroline_Business_Standing_Side_public", "Caroline_Casual_Sitting_Front_public", "Caroline_Casual_Sitting_Side_public", "Caroline_Kitchen_Standing_Front_public", "Caroline_Kitchen_Standing_Side_public", "Caroline_Lobby_Sitting_Front_public", "Caroline_Lobby_Sitting_Side_public", "Caroline_Lobby_Standing_Front_public", "Caroline_Lobby_Standing_Side_public", "Caroline_Office_Sitting_Front_public", "Caroline_Office_Sitting_Side_public", "Caroline_Office_Standing_Front_public", "Caroline_Office_Standing_Side_public", "Caroline_Sofa_Sitting_Front_public", "Caroline_Sofa_Sitting_Side_public", "Chloe_standing_lounge_front", "Chloe_standing_lounge_side", "Chloe_standing_outdoor_side", "Conrad_sitting_house_side", "Conrad_sitting_sofa_front", "Conrad_standing_house_front", "Conrad_standing_sofa_side", "Derya_sitting_indoor_front", "Derya_sitting_indoor_side", "Derya_sitting_office_front", "Derya_sitting_office_side", "Derya_standing_indoor_front", "Derya_standing_indoor_side", "Derya_standing_office_front", "Derya_standing_office_side", "Dexter_Doctor_Sitting2_public", "Dexter_Doctor_Standing2_public", "Dexter_Lawyer_Sitting_public", "Elenora_FitnessCoach2_public", "Elenora_FitnessCoach_public", "Elenora_IT_Sitting_public", "Emanuel_sitting_Sofa_side", "Emanuel_sitting_sofa_front", "Emanuel_standing_office_front", "Emanuel_standing_office_side", "Emilia_sitting_outdooryoga2_front", "Emilia_sitting_outdooryoga_front", "Emilia_sitting_outdooryoga_side", "Emilia_sitting_picnic_front", "Emilia_sitting_picnic_side", "Emilia_standing_outdoorbusiness_front", "Emilia_standing_outdoorbusiness_side", "Eric_public_lite1_20230601", "Fernando_sitting_businessindoor_front", "Fernando_sitting_businessindoor_side", "Fernando_sitting_outdoorchair_front", "Fernando_sitting_outdoorchair_front_close", "Fernando_sitting_outdoorchair_side", "Fernando_sitting_outdoortable_front", "Fernando_sitting_outdoortable_side", "Fernando_standing_outdoor_front", "Fernando_standing_outdoor_side", "Gala_lying_bedroom_front", "Gala_lying_sofa_front", "Gala_lying_sofa_side", "Gala_sitting_businesssofa_front", "Gala_sitting_businesssofa_side", "Gala_sitting_casualsofawithipad_front", "Gala_sitting_casualsofawithipad_side", "Gala_sitting_casualsofawithipad_side_close", "Gala_sitting_office_front", "Gala_sitting_office_side", "Gala_sitting_sofa_front", "Gala_sitting_sofa_front_close", "Gala_sitting_sofa_side", "Gala_sitting_sofa_side_close", "Gala_standing_businesssofa_front", "Gala_standing_businesssofa_front_close", "Gala_standing_businesssofa_side", "Gala_standing_businesssofa_side_close", "Georgia_sitting_office_front", "Georgia_sitting_office_side", "Georgia_standing_casual_front", "Georgia_standing_casual_side", "Gerardo_sitting_indoor_front", "Gerardo_sitting_indoor_side", "Gerardo_sitting_sofa_front", "Gerardo_sitting_sofa_side", "Gerardo_standing_nightscene2_front", "Gerardo_standing_nightscene_front", "Gerardo_standing_outdoorsport_front", "Gerardo_standing_outdoorsport_side", "Giulia_sitting_office_front", "Giulia_sitting_office_side", "Giulia_sitting_sofa_front", "Giulia_sitting_sofa_side", "Giulia_standing_office_front", "Giulia_standing_office_side", "Giulia_standing_sofa_front", "Giulia_standing_sofa_side", "Ida_sitting_lounge_front", "Ida_sitting_lounge_side", "Ida_sitting_sofa_front", "Ida_sitting_sofa_side", "Ida_standing_lounge_front", "Ida_standing_lounge_side", "Ida_standing_sofa_front", "Ida_standing_sofa_side", "Jocelyn_sitting_office_front", "Jocelyn_sitting_office_side", "Jocelyn_sitting_sofa_front", "Jocelyn_sitting_sofa_side", "Jocelyn_standing_office_front", "Jocelyn_standing_office_side", "Jocelyn_standing_sofa_front", "Jocelyn_standing_sofa_side", "Joel_sitting_couch_front", "Joel_sitting_couch_side", "Joel_standing_gym_front", "Joel_standing_gym_side", "Joel_standing_mountain_front", "Joel_standing_mountain_side", "Jonas_sitting_gym_front", "Jonas_sitting_gym_side", "Jonas_standing_gym_front", "Jonas_standing_gym_side", "Juan_sitting_office_front", "Juan_sitting_office_side", "Juan_sitting_sofa_front", "Juan_sitting_sofa_side", "Juan_sitting_sofacasual_front", "Juan_standing_office_front", "Juan_standing_office_side", "Juan_standing_sofa_front", "Juan_standing_sofa_side", "Juan_standing_sofacasual_front", "Judita_sitting_yoga_front", "Judita_sitting_yoga_side", "Judita_standing_yoga_front", "Judita_standing_yoga_side", "Judy_Doctor_Sitting2_public", "Judy_Doctor_Standing2_public", "Judy_Lawyer_Sitting2_public", "Judy_Teacher_Sitting2_public", "Judy_Teacher_Sitting_public", "Judy_Teacher_Standing_public", "June_HR_public", "June_sitting_office_front", "June_sitting_office_side", "June_sitting_sofacasual_side", "June_standing_office_side", "June_standing_sofacasual_side", "Kavya_sitting_sofa_front", "Kavya_sitting_sofa_side", "Kavya_standing_indoor_front", "Kavya_standing_indoor_side", "Kavya_standing_outdoor_side", "Kavya_standing_outdoorsport_front", "Kavya_standing_outdoorsport_side", "Leos_sitting_office_front", "Leos_sitting_office_side", "Leos_sitting_sofa_front", "Leos_sitting_sofa_side", "Leos_standing_office_front", "Leos_standing_office_side", "Leos_standing_sofa_front", "Leos_standing_sofa_side", "Leszek_sitting_lounge_front", "Leszek_sitting_lounge_side", "Leszek_sitting_sofa_front", "Leszek_sitting_sofa_side", "Leszek_standing_outdoorbusiness_front", "Leszek_standing_outdoorbusiness_side", "Leszek_standing_outdoorcasual_front", "Leszek_standing_outdoorcasual_side", "Lily_public_lite1_20230601", "Martina_sitting_office_front", "Martina_sitting_office_side", "Martina_sitting_sofa_front", "Martina_sitting_sofa_side", "Martina_standing_office_front", "Martina_standing_office_side", "Martina_standing_sofa_front", "Martina_standing_sofa_side", "Masha_sitting_office_front", "Masha_sitting_office_side", "Masha_sitting_sofacasual_front", "Masha_sitting_sofacasual_side", "Masha_standing_office_front", "Masha_standing_office_side", "Masha_standing_sofacasual_front", "Masha_standing_sofacasual_side", "Matteo_sitting_office_front", "Matteo_sitting_office_side", "Matteo_sitting_sofa_front", "Matteo_sitting_sofa_side", "Matteo_standing_office_front", "Matteo_standing_office_side", "Matteo_standing_sofa_front", "Matteo_standing_sofa_side", "Max_sitting_indoor_front", "Max_sitting_indoor_side", "Max_standing_outdoorsport_front", "Max_standing_outdoorsport_side", "Mido-lite-20221128", "Milena_sitting_office_front", "Milena_sitting_office_side", "Milena_sitting_sofa_front", "Milena_sitting_sofa_side", "Milena_standing_office_front", "Milena_standing_office_side", "Milena_standing_sofa_front", "Milena_standing_sofa_side", "Miles_sitting_sofa_front", "Miles_sitting_sofa_side", "Miles_standing_outdoor_front", "Miles_standing_outdoor_side", "Miles_standing_sofa_front", "Miles_standing_sofa_side", "Mireia_sitting_businessindoor_front", "Mireia_sitting_businessindoor_side", "Mireia_sitting_outdoorchair_front", "Mireia_sitting_outdoortable_front", "Mireia_sitting_outdoortable_side", "Mireia_standing_outdoor_front", "Mireia_standing_outdoor_side", "Miyu_sitting_office_front", "Miyu_sitting_office_side", "Miyu_sitting_sofabusiness_front", "Miyu_sitting_sofabusiness_side", "Miyu_sitting_sofacasual_front", "Miyu_sitting_sofacasual_side", "Miyu_standing_office_front", "Miyu_standing_office_side", "Miyu_standing_sofacasual_front", "Miyu_standing_sofacasual_side", "Noah_sitting_lobby_front", "Noah_sitting_lobby_side", "Noah_sitting_office_front", "Noah_sitting_office_side", "Noah_sitting_sofa_front", "Noah_sitting_sofa_side", "Noah_standing_lobby_front", "Noah_standing_lobby_side", "Noah_standing_office_front", "Noah_standing_office_side", "Noah_standing_sofa_front", "Noah_standing_sofa_side", "Oxana_sitting_gym_front", "Oxana_sitting_gym_side", "Oxana_sitting_office_front", "Oxana_sitting_office_side", "Oxana_sitting_sofa_front", "Oxana_sitting_sofa_side", "Oxana_sitting_yoga_front", "Oxana_sitting_yoga_side", "Oxana_standing_gym_front", "Oxana_standing_gym_side", "Oxana_standing_office_front", "Oxana_standing_office_side", "Oxana_standing_sofa_front", "Oxana_standing_sofa_side", "Oxana_standing_yoga_front", "Oxana_standing_yoga_side", "Patrizio_sitting_office_front", "Patrizio_sitting_office_side", "Patrizio_sitting_sofa_front", "Patrizio_sitting_sofa_side", "Patrizio_standing_businesstraining_front", "Patrizio_standing_businesstraining_side", "Patrizio_standing_office_side", "Piper_sitting_businesssofa_front", "Piper_sitting_businesssofa_side", "Piper_standing_education_front", "Piper_standing_education_side", "Rasmus_sitting_lounge_front", "Rasmus_sitting_lounge_side", "Rasmus_sitting_sofa_front", "Rasmus_sitting_sofa_side", "Rasmus_standing_lounge_front", "Rasmus_standing_lounge_side", "Rasmus_standing_sofa_front", "Rasmus_standing_sofa_side", "Raul_Sitting_businesssofa_front", "Raul_Sitting_businesssofa_front_close", "Raul_sitting_businesssofa_side", "Raul_sitting_casualsofanoipad_front", "Raul_sitting_casualsofanoipad_side", "Raul_sitting_casualsofawithipad_front", "Raul_sitting_casualsofawithipad_side", "Raul_sitting_office_front", "Raul_sitting_office_side", "Raul_sitting_sofa_front", "Raul_sitting_sofa_front_close", "Raul_sitting_sofa_side", "Raul_sitting_sofa_side_close", "Raul_standing_businesssofa_side", "Raul_standing_casualsofa_front", "Raul_standing_casualsofa_front_close", "Raul_standing_casualsofa_side", "Raul_standing_casualsofa_side_close", "Raul_standing_office_front", "Ren_sitting_office_front", "Ren_sitting_office_side", "Ren_sitting_sofabusiness_front", "Ren_sitting_sofabusiness_side", "Ren_sitting_sofacasual_front", "Ren_sitting_sofacasual_side", "Ren_standing_office_front", "Ren_standing_office_side", "Ren_standing_sofacasual_front", "Ren_standing_sofacasual_side", "Riley_siting_casual_front", "Riley_sitting_casual_side", "Riley_sitting_office_front", "Riley_sitting_office_side", "Roman_standing_outdoorsport_front", "Roman_standing_outdoorsport_side", "Sabine_sitting_office_front", "Sabine_sitting_sofa_side", "Sabine_standing_office_front", "Sabine_standing_office_side", "Santa_Fireplace_Front_public", "Santa_Fireplace_Side_public", "Scarlett_siiting_fireplace_front", "Scarlett_sitting_couch2_front", "Scarlett_sitting_couch2_side", "Scarlett_sitting_couch_front", "Scarlett_sitting_couch_side", "Scarlett_sitting_fireplace_side", "Scarlett_sitting_yoga_front", "Scarlett_sitting_yoga_side", "Scarlett_standing_hall_front", "Scarlett_standing_hall_side", "Shawn_Therapist_public", "SilasHR_public", "Silas_CustomerSupport_public", "Silas_sitting_lounge_front", "Silas_sitting_lounge_side", "Silas_sitting_sofa_side", "Silas_sitting_sofa_side_close", "Teodor_sitting_office_front", "Teodor_sitting_office_side", "Teodor_sitting_sofa_front", "Teodor_sitting_sofa_side", "Teodor_standing_office_front", "Teodor_standing_office_side", "Teodor_standing_sofa_front", "Teodor_standing_sofa_side", "Timothy_sitting_casual_front", "Timothy_sitting_casual_side", "Timothy_sitting_office_front", "Timothy_sitting_office_side", "Veit_sitting_sofa_front", "Veit_sitting_sofa_side", "Veit_standing_office_front", "Veit_standing_office_side", "Vemon_sitting_office_front", "Vemon_sitting_office_side", "Vemon_standing_office_front", "Vemon_standing_office_side", "Verena_sitting_sofa_front", "Verena_sitting_sofa_side", "Verena_standing_office_front", "Verena_standing_office_side", "Vernon_sitting_lounge_side", "Vernon_standing_lounge_front", "Vernon_standing_lounge_side", "Vince_sitting_businesssofa_front", "Vince_sitting_businesssofa_side", "Vince_sitting_sofacasual_front", "Vince_sitting_sofacasual_side", "Vince_standing_businesstraining_front", "Vince_standing_businesstraining_side", "Vince_standing_sofacasual_front", "Vince_standing_sofacasual_side" - **`audio`** (`string`, _required_): Speech audio that drives the talking video. - **`background`** (`string`, _optional_): Optional background image URL. - **`resolution`** (`string`, _optional_): Output video resolution. - Default: `"1080p"` - Options: "720p", "1080p", "4k" - **`aspect_ratio`** (`string`, _optional_): Output aspect ratio. Default: 16:9. - Default: `"16:9"` - Options: "16:9", "9:16", "1:1", "5:4", "4:5" **Required Parameters Example**: ```json { "avatar": "Abigail_sitting_sofa_front", "audio": "https://interactive-examples.mdn.mozilla.net/media/cc0-audio/t-rex-roar.mp3" } ``` **Full Example**: ```json { "avatar": "Abigail_sitting_sofa_front", "audio": "https://interactive-examples.mdn.mozilla.net/media/cc0-audio/t-rex-roar.mp3", "background": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg", "resolution": "1080p", "aspect_ratio": "16:9" } ``` ### Result Data Schema The `data` object returned by the API has the following fields: - **`created_at`** (`string (date-time)`, _optional_): ISO timestamp of when the request was created (e.g., "2023-04-01T12:34:56.789Z"). - **`id`** (`string`, _optional_): Unique identifier for the prediction, the ID of the prediction to get. - **`model`** (`string`, _optional_): Model ID used for the prediction. - **`outputs`** (`array of string | object`, _optional_): Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model. - **`status`** (`string`, _optional_): Status of the task: created, processing, completed, or failed. - **`urls`** (`object`, _optional_): Object containing related API endpoints. **Example `data` Object**: ```json { "created_at": "example", "id": "example", "model": "example", "outputs": [], "status": "example", "urls": {} } ``` ## Usage Examples The examples use `jq` to read JSON. Set your API key first: ```bash set -euo pipefail export WAVESPEED_API_KEY="your-api-key" ``` ### 1. Submit a prediction ```bash REQUEST_BODY=$(cat <<'JSON' { "avatar": "Abigail_sitting_sofa_front", "audio": "https://interactive-examples.mdn.mozilla.net/media/cc0-audio/t-rex-roar.mp3" } JSON ) SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \ --request POST \ --url https://api.wavespeed.ai/api/v3/heygen/avatar-v \ --header "Authorization: Bearer ${WAVESPEED_API_KEY}" \ --header "Content-Type: application/json" \ --data "${REQUEST_BODY}") printf '%s\n' "${SUBMIT_RESPONSE}" | jq . ``` The response contains the prediction ID in `data.id`. ### 2. Poll until complete and read `outputs` ```bash PREDICTION_ID=$(printf '%s' "${SUBMIT_RESPONSE}" | jq -r '.data.id') if [ -z "${PREDICTION_ID}" ] || [ "${PREDICTION_ID}" = "null" ]; then printf 'Submission response did not contain data.id\n' >&2 exit 1 fi RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result" while true; do RESPONSE=$(curl --silent --show-error --fail-with-body \ --request GET \ --url "${RESULT_URL}" \ --header "Authorization: Bearer ${WAVESPEED_API_KEY}") RESULT=$(printf '%s' "${RESPONSE}" | jq -e '.data') STATUS=$(printf '%s' "${RESULT}" | jq -er '.status') case "${STATUS}" in completed) # Generated files are returned in the outputs array. printf '%s\n' "${RESULT}" | jq '.outputs' break ;; failed|cancelled|timeout|deleted) printf '%s\n' "${RESULT}" | jq '{status, error, code}' exit 1 ;; *) sleep 2 ;; esac done ``` ## Additional Resources ### Documentation - [Model Playground](https://wavespeed.ai/models/heygen/avatar-v) - [API Documentation](https://wavespeed.ai/docs/docs-api/heygen/heygen-avatar-v)