Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gmicloud.ai/llms.txt

Use this file to discover all available pages before exploring further.

Generate avatar videos using HeyGen Avatar IV. Supports photo avatars, digital twins, and studio avatars at up to 4K resolution. Model ID 
heygen-avatar-v4
Required fields:
  • video_inputs: array of segments, each with a character (avatar config) and voice (TTS or audio clip)
Optional fields:
  • dimension: output resolution, default {“width”: 1280, “height”:720}
  • duration: expected seconds, used only for billing estimation

​
API Usage

Submit a generation task via the GMI request queue. Polling and full parameter docs are in the API reference.

​
Submit request

curl -X POST "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests" \
  -H "Authorization: Bearer $GMI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "heygen-avatar-v4",
    "payload": {
      "prompt": "your prompt here"
    }
  }'
The response includes a request_id. Poll the status endpoint until the video is ready, then download from the returned URL. 
curl "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests/<request_id>" \
  -H "Authorization: Bearer $GMI_API_KEY"