HEheygen
Avatars

Update Avatar Group

Changed on

Updates an avatar group you own. Currently sets default_voice_id, the voice this avatar uses by default; any voice in your workspace works, including clones. Public avatars cannot be updated.

patch/v3/avatars/{group_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/avatars/{group_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

group_idstring required

Unique avatar group identifier

Request body

default_voice_idstring nullable

Voice ID to set as the avatar's default voice, replacing the current one. The voice is also linked to the avatar group if it was not already. Accepts any voice available to your workspace, including imported voice clones. Only supported for avatars you own.

Example request

{
  "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2"
}

Response

Successful response

Example response

{
  "data": {
    "id": "ag_abc123",
    "name": "Anna",
    "preview_image_url": "https://files.heygen.ai/avatar/anna_preview.jpg",
    "preview_video_url": "https://files.heygen.ai/avatar/anna_preview.mp4",
    "gender": "female",
    "created_at": 1711929600,
    "looks_count": 3,
    "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
    "consent_status": "accepted",
    "error": {
      "code": "training_failed",
      "message": "Footage duration must be between 15s and 600s"
    }
  }
}

Changes