HEheygen
Photo Avatars

Generate photo avatar photos

This endpoint will generate photos that can be used to create photo avatars, returns a generation id, which can be used in the check generation status endpoint to get status and final image/image keys

post/v2/photo_avatar/photo/generate

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v2/photo_avatar/photo/generate
  • Auth
    API key in header X-API-KEY

Request body

namestring
age'Young Adult' | 'Early Middle Age' | 'Late Middle Age' | 'Senior' | 'Unspecified'
gender'Woman' | 'Man' | 'Unspecified'
ethnicity'White' | 'Black' | 'Asian American' | 'East Asian' | 'South East Asian' | 'South Asian' | 'Middle Eastern' | 'Pacific' | 'Hispanic' | 'Unspecified'
orientation'square' | 'horizontal' | 'vertical'
pose'half_body' | 'close_up' | 'full_body'
style'Realistic' | 'Pixar' | 'Cinematic' | 'Vintage' | 'Noir' | 'Cyberpunk' | 'Unspecified'
appearancestring

Description/Prompt of the generated avatar photo, maximum 1000 characters

Response

200

errorunknown

Example response

{
  "data": {
    "generation_id": "51be01eda38e4c2b9836f06957f66b7d"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.