> ## Documentation Index
> Fetch the complete documentation index at: https://docs.liveavatar.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Image Avatar (Alpha)

> **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.



## OpenAPI

````yaml /openapi.json post /v1-alpha/avatars/image
openapi: 3.1.0
info:
  title: Live avatar API
  version: 0.1.0
servers:
  - url: https://api.liveavatar.com
security: []
paths:
  /v1-alpha/avatars/image:
    post:
      tags:
        - Avatar
      summary: Create Image Avatar (Alpha)
      description: >-
        **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.
      operationId: create_image_avatar_v1_alpha_avatars_image_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/Body_create_image_avatar_v1_alpha_avatars_image_post
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_AvatarSchema_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    Body_create_image_avatar_v1_alpha_avatars_image_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        resolution:
          $ref: '#/components/schemas/AvatarResolutionEnum'
          default: 720
      type: object
      required:
        - file
      title: Body_create_image_avatar_v1_alpha_avatars_image_post
    Response_AvatarSchema_:
      properties:
        code:
          type: integer
          title: Code
          default: 100
        data:
          anyOf:
            - $ref: '#/components/schemas/AvatarSchema'
            - type: 'null'
        message:
          title: Message
          type: string
      type: object
      title: Response[AvatarSchema]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AvatarResolutionEnum:
      type: integer
      enum:
        - 720
        - 1080
      title: AvatarResolutionEnum
      description: >-
        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.
    AvatarSchema:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        space_id:
          title: Space Id
          type: string
        type:
          $ref: '#/components/schemas/AvatarTypeEnum'
          default: VIDEO
        status:
          $ref: '#/components/schemas/AvatarStatusEnum'
          default: INIT
        name:
          type: string
          title: Name
        preview_url:
          title: Preview Url
          type: string
        default_voice:
          anyOf:
            - $ref: '#/components/schemas/DefaultAvatarVoice'
            - type: 'null'
        default_voice_agent_id:
          title: Default Voice Agent Id
          type: string
        is_1080p:
          type: boolean
          title: Is 1080P
          default: false
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        is_expired:
          type: boolean
          title: Is Expired
          readOnly: true
        error_message:
          title: Error Message
          description: >-
            Error message if training failed (prefer detailed, fallback to
            short).
          readOnly: true
          type: string
      type: object
      required:
        - id
        - name
        - created_at
        - updated_at
        - is_expired
        - error_message
      title: AvatarSchema
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          title: Message
          type: string
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    AvatarTypeEnum:
      type: string
      enum:
        - IMAGE
        - VIDEO
      title: AvatarTypeEnum
    AvatarStatusEnum:
      type: string
      enum:
        - ACTIVE
        - INIT
        - DEPLOYING
        - FAILED
        - DEACTIVATED
        - DELETED
      title: AvatarStatusEnum
    DefaultAvatarVoice:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - name
      title: DefaultAvatarVoice
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.