Create Instant Avatar

Upload a photo and create a Quick Start (image-mode) avatar.

Accepts multipart form data with a ‘photo’ file (JPEG, PNG, WebP) plus the gate-1 consent payload: consent_attestation (must be true) and subject_is_minor (must be false — minors hard-stop). Optional voice_id (catalog voice name) and default_prompt (default script) are stored on the avatar config. The request IP and a UTC timestamp are captured server-side into the team’s consent_log. No HeyGen creation call — the photo IS the render input.

POST /api/v1/teams/{team_id}/avatar/instant

Create Instant Avatar

cURL

curl --request POST \
  --url https://api.example.com/api/v1/teams/{team_id}/avatar/instant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'photo=<string>' \
  --form consent_attestation=true \
  --form subject_is_minor=true \
  --form 'voice_id=<string>' \
  --form 'default_prompt=<string>'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id · string<uuid> · required

Body

multipart/form-data

photo · string · required

consent_attestation · boolean · required

subject_is_minor · boolean · required

voice_id · string | null

default_prompt · string | null

Response

200

application/json

Successful Response