> ## Documentation Index > Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi/external-api.json post /v3/avatars/{group_id}/consent openapi: 3.1.0 info: title: HeyGen External API version: 1.0.0 description: >- HeyGen's external API for programmatic AI video creation. See https://docs.heygen.com for full documentation. contact: name: HeyGen Product Infra url: https://heygen.com servers: - url: https://api.heygen.com description: Production security: - ApiKeyAuth: [] - BearerAuth: [] tags: - name: Video Agent description: Create videos from text prompts using AI - name: Videos description: Create, list, retrieve, and delete videos - name: Voices description: Text-to-speech and voice management - name: Audio description: Search the background-music and sound-effects catalog - name: Video Translate description: Translate videos into other languages - name: User description: Account information and billing - name: Avatars description: List and manage avatars and looks - name: Assets description: Upload files for use in video creation - name: Webhooks description: Manage webhook endpoints and events - name: Lipsync description: Dub or replace audio on existing videos - name: Brand description: >- Brand-related resources — brand kits (colors, fonts, logos) and brand glossaries (custom term translations) paths: /v3/avatars/{group_id}/consent: post: tags: - Avatars summary: Create Avatar Consent description: >- 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. operationId: createAvatarConsent parameters: - name: group_id in: path required: true schema: type: string description: Unique avatar group identifier - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAvatarConsentRequest' responses: '200': description: Successful response content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CreateAvatarConsentResponse' '400': description: Invalid request parameters content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' '401': description: Authentication failed content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: authentication_failed message: Invalid or expired API key. Verify your x-api-key header. param: null doc_url: null '404': description: Resource not found content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: avatar_group_not_found message: Avatar group not found. param: null doc_url: null '409': $ref: '#/components/responses/IdempotencyInProgress' '429': description: Rate limit exceeded content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: rate_limit_exceeded message: >- Too many requests. Retry after the duration specified in the Retry-After header. param: null doc_url: null headers: Retry-After: description: Seconds to wait before retrying schema: type: integer security: - ApiKeyAuth: [] - BearerAuth: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- 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. schema: type: string pattern: ^[A-Za-z0-9_\-:.]{1,255}$ maxLength: 255 minLength: 1 example: 550e8400-e29b-41d4-a716-446655440000 schemas: CreateAvatarConsentRequest: description: Request body for POST /v3/avatars/{group_id}/consent. properties: reroute_url: anyOf: - type: string - type: 'null' default: null description: >- Callback URL where the user is redirected after completing consent. Defaults to HeyGen's consent completion page. title: Reroute Url consent_text: anyOf: - maxLength: 1000 type: string - type: 'null' default: null description: >- 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. title: Consent Text x-cli-visible: false x-mcp-visible: false title: CreateAvatarConsentRequest type: object CreateAvatarConsentResponse: description: Response body for POST /v3/avatars/{group_id}/consent. properties: avatar_group: $ref: '#/components/schemas/AvatarGroupItem' description: The avatar group associated with this consent. url: description: URL to the consent page. title: Url type: string required: - avatar_group - url title: CreateAvatarConsentResponse type: object StandardAPIError: type: object properties: code: type: string description: Machine-readable error code example: invalid_parameter message: type: string description: Human-readable error message example: Video not found param: type: - string - 'null' description: Which request field caused the error doc_url: type: - string - 'null' description: Link to error documentation required: - code - message AvatarGroupItem: description: >- A single avatar group in the list response. Groups are containers for looks (outfits/styles). To determine avatar type and engine compatibility, fetch the looks via GET /v3/avatars/looks. properties: id: description: Unique avatar group identifier. examples: - ag_abc123 title: Id type: string name: description: Display name of the avatar. examples: - Anna title: Name type: string preview_image_url: anyOf: - type: string - type: 'null' default: null description: URL to the avatar preview image. examples: - https://files.heygen.ai/avatar/anna_preview.jpg title: Preview Image Url preview_video_url: anyOf: - type: string - type: 'null' default: null description: URL to the avatar preview video. examples: - https://files.heygen.ai/avatar/anna_preview.mp4 title: Preview Video Url gender: anyOf: - type: string - type: 'null' default: null description: Gender of the avatar. examples: - female title: Gender created_at: description: Unix timestamp (seconds) when the avatar was created. examples: - 1711929600 title: Created At type: integer looks_count: description: Number of looks (outfits/styles) available for this avatar. examples: - 3 title: Looks Count type: integer default_voice_id: anyOf: - type: string - type: 'null' default: null description: Default voice ID for this avatar. examples: - 1bd001e7e50f421d891986aad5c8bbd2 title: Default Voice Id consent_status: anyOf: - type: string - type: 'null' default: null description: >- The status of consent for the group. None means consent is not required. examples: - approved title: Consent Status status: anyOf: - $ref: '#/components/schemas/AvatarStatus' - type: 'null' default: null description: >- Training status of the avatar group. Only present for private avatars. examples: - completed error: anyOf: - $ref: '#/components/schemas/AvatarError' - type: 'null' default: null description: Error details. Only present when status is 'failed'. required: - id - name - created_at - looks_count title: AvatarGroupItem type: object AvatarStatus: description: Training/creation status of an avatar group or look. enum: - processing - pending_consent - failed - completed title: AvatarStatus type: string AvatarError: description: Error details for a failed avatar creation. properties: code: description: Machine-readable error code. examples: - training_failed title: Code type: string message: description: Human-readable error description. examples: - Footage duration must be between 15s and 600s title: Message type: string required: - code - message title: AvatarError type: object responses: IdempotencyInProgress: description: >- A prior request with this Idempotency-Key is still in progress. Wait for the original request to complete, then retry. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: request_in_progress message: >- A request with this Idempotency-Key is already in progress. Retry shortly. param: null doc_url: null securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: HeyGen API key. Obtain from your HeyGen dashboard. BearerAuth: type: http scheme: bearer description: OAuth2 bearer token. ````