v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB

Avatars

Update Avatar Look

Updates the display name of an avatar look. Only supported for photo avatar and digital twin look types.

patch/v3/avatars/looks/{look_id}

Path parameters

look_idstring required

Unique avatar look identifier. This is the value to pass as avatar_id to POST /v3/videos.

Request body

namestring nullable

New display name for the look.

Response

Successful response

Example response

{
  "data": {
    "id": "lk_abc123",
    "name": "Business Suit",
    "group_id": "ag_abc123",
    "preview_image_url": "https://files.heygen.ai/look/business_preview.jpg",
    "preview_video_url": "https://files.heygen.ai/look/business_preview.mp4",
    "gender": "female",
    "tags": [
      "business",
      "formal"
    ],
    "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
    "supported_api_engines": [
      "avatar_v",
      "avatar_iv",
      "avatar_iii"
    ],
    "image_width": 1920,
    "image_height": 1080,
    "error": {
      "code": "training_failed",
      "message": "Footage duration must be between 15s and 600s"
    }
  }
}