v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB

Avatars

Create Avatar Consent

Initiates the consent flow for an avatar group and returns a URL for the user to complete approval in their browser. Required before a private avatar can be used for video generation.

post/v3/avatars/{group_id}/consent

Path parameters

group_idstring required

Unique avatar group identifier

Headers

Idempotency-Keystring

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Request body

reroute_urlstring nullable

Callback URL where the user is redirected after completing consent. Defaults to HeyGen's consent completion page.

consent_textstring nullable

Custom consent text rendered on the consent page in place of the default HeyGen text. Available as a premium option for select Enterprise customers — e.g. to display co-branded language like "I, (Name), hereby allow HeyGen and {Company} to use footage of me...". Plain text only; rendered as text (not HTML). The characters < and > are rejected to prevent stored-HTML injection. To request access, please contact our support team.

Response

Successful response

Example response

{
  "data": {
    "avatar_group": {
      "id": "ag_abc123",
      "name": "Anna",
      "preview_image_url": "https://files.heygen.ai/avatar/anna_preview.jpg",
      "preview_video_url": "https://files.heygen.ai/avatar/anna_preview.mp4",
      "gender": "female",
      "created_at": 1711929600,
      "looks_count": 3,
      "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
      "consent_status": "approved",
      "error": {
        "code": "training_failed",
        "message": "Footage duration must be between 15s and 600s"
      }
    }
  }
}