Avatar

Create Image Avatar (Alpha)

Changed on

Alpha: this endpoint may change or be removed without notice.

Create an image avatar from a single JPEG or PNG upload (multipart). The image must be exactly 16:9 or 9:16 with a short side of at least 1080px, and show one clearly framed person. A failing image returns 400 with the reason for each failed check. On success the avatar is returned in INIT; poll GET /v1/avatars/{id} until it is ACTIVE. 1080p training requires a Business or Enterprise plan.

post/v1-alpha/avatars/image

Request

  • Base URL
    https://api.liveavatar.com
  • URL
    https://api.liveavatar.com/v1-alpha/avatars/image
  • Auth
    API key in header X-API-KEY

Request body multipart/form-data

filestring binary required
resolution720 | 1080

Training resolution for an avatar.

Values are the integer pixel-height (matches what the heygen platform's A2V deployment worker accepts), so existing comparisons like if resolution == AvatarResolutionEnum.RESOLUTION_1080P keep reading naturally.

Response

Successful Response

codeinteger
messagestring

Changes