---
title: "Get HeyGen Image"
method: GET
path: "/v3/models/images/{generation_id}"
tags: ["Models"]
---

# Get HeyGen Image

`GET /v3/models/images/{generation_id}`

## Request

- Base URL: `https://api.heygen.com`
- URL: `https://api.heygen.com/v3/models/images/{generation_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Return the generation job status and ordered images with fresh download URLs once the entire job completes.

## Path parameters

- `generation_id` string, required

## Response `200`

Successful response

- object
  - `data` ImageGenerationResponse
    - `generation_id` string, required: Generation job identifier returned by creation.
    - `status` 'pending' | 'completed' | 'failed' | 'cancelled', required: Current generation status.
    - `model` 'heygen-image-1', required
    - `num_images` integer, required: Number of images requested for this generation job.
    - `created_at` integer, required: Request creation time as Unix seconds.
    - `images` GeneratedImageResponse[], required: Generated images in stable output order. Contains exactly num_images entries when completed; empty for every other status.
      - `image_id` string, required: Unique identifier of this generated image, distinct from the generation job identifier.
      - `image_url` string, required: Download URL. Poll the generation again to obtain a fresh URL.
      - `width` integer, required: Generated image width in pixels.
      - `height` integer, required: Generated image height in pixels.
      - `seed` integer, required: Actual seed used for this image.
    - `failure_code` 'generation_failed' | 'generation_cancelled' | 'insufficient_credit' | 'usage_limit_reached' | 'no_face_detected' | 'multiple_faces_detected', nullable: Failure code, present when failed or cancelled. Face detection failures require replacing the indicated input image.
    - `failure_message` string, nullable: Failure explanation, present when failed or cancelled.

## Other responses

- `400`: Invalid request parameters
- `401`: Authentication failed
- `404`: Resource not found
- `429`: Rate limit exceeded

## Changes

- **2026-11-03** `7dfa5e59b4f5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/heygen/apis/heygen-external-api/changes/v3/models/images/:generation_id/get.md)

---

[API](https://skmtc.dev/heygen/apis/heygen-external-api.md) - [All operations](https://skmtc.dev/heygen/apis/heygen-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/heygen/apis/heygen-external-api/revisions/7dfa5e59b4f5?raw)
