Update Avatar Look

cURL

curl --request PATCH \
  --url https://api.heygen.com/v3/avatars/looks/{look_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'

Response Codes

  • 200
  • 400
  • 401
  • 404
  • 429
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "avatar_type": "studio_avatar",
    "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": [
      "<string>"
    ],
    "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
    "supported_api_engines": [
      "<string>"
    ],
    "image_width": 1920,
    "image_height": 1080,
    "preferred_orientation": "portrait",
    "status": "completed",
    "error": {
      "code": "<string>",
      "message": "<string>"
    }
  }
}

Authorizations

  • x-api-key
    • Type: string
    • Location: header
    • Required: Yes
    • Description: HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

  • look_id
    • Type: string
    • Required: Yes
    • Description: Unique avatar look identifier. This is the value to pass as avatar_id to POST /v3/videos.

Body

  • name
    • Type: string | null
    • Description: New display name for the look. Maximum string length: 255

Response

  • 200
    • Description: Successful response
    • Schema:
{
  "data": {
    // Avatar look information
  }
}