> ## Documentation Index > Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get HeyGen Image > Return the generation job status and ordered images with fresh download URLs once the entire job completes. ## OpenAPI ````yaml /openapi/external-api.json get /v3/models/images/{generation_id} 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: Templates description: Generate videos from reusable templates by replacing their variables - 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: AI Clipping description: Turn long-form videos into ready-to-share short clips with captions - name: Batches description: Create and track batches of videos. - name: Video Translation Batches description: Create and track batches of video translations. - name: Lipsync Batches description: Create and track batches of lipsyncs. - name: Asset Batches description: Create and track batches of direct-to-S3 asset uploads. - name: User description: Account information and billing - name: API Keys description: Inspect the API key authenticating the current request - name: Avatars description: List and manage avatars and looks - name: Assets description: Upload files for use in video creation - name: Folders description: >- Create folders to organize videos and translations in the workspace, and look up any folder, Assets library folders included, by id - 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) - name: HyperFrames description: Render HyperFrames composition zips into video — separate from /v3/videos - name: Models description: '' - name: Filler Word Removal description: '' paths: /v3/models/images/{generation_id}: get: tags: - Models summary: Get HeyGen Image description: >- Return the generation job status and ordered images with fresh download URLs once the entire job completes. operationId: getImageGeneration parameters: - name: generation_id in: path required: true schema: type: string description: Generation job identifier returned by create image generation. responses: '200': description: Successful response content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ImageGenerationResponse' '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: unauthorized 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: resource_not_found message: Image generation not found. param: null doc_url: null '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: schemas: ImageGenerationResponse: properties: generation_id: description: Generation job identifier returned by creation. title: Generation Id type: string status: description: Current generation status. enum: - pending - completed - failed - cancelled title: Status type: string model: $ref: '#/components/schemas/ImageGenerationModel' description: Requested image generation model. num_images: description: Number of images requested for this generation job. maximum: 5 minimum: 1 title: Num Images type: integer created_at: description: Request creation time as Unix seconds. title: Created At type: integer images: description: >- Generated images in stable output order. Contains exactly num_images entries when completed; empty for every other status. items: $ref: '#/components/schemas/GeneratedImageResponse' title: Images type: array failure_code: anyOf: - enum: - generation_failed - generation_cancelled - insufficient_credit - usage_limit_reached - no_face_detected - multiple_faces_detected type: string - type: 'null' default: null description: >- Failure code, present when failed or cancelled. Face detection failures require replacing the indicated input image. title: Failure Code failure_message: anyOf: - type: string - type: 'null' default: null description: Failure explanation, present when failed or cancelled. title: Failure Message required: - generation_id - status - model - num_images - created_at - images title: ImageGenerationResponse 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 errors: type: array description: >- Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node). items: $ref: '#/components/schemas/StandardAPIErrorDetail' required: - code - message ImageGenerationModel: enum: - heygen-image-1 title: ImageGenerationModel type: string GeneratedImageResponse: properties: image_id: description: >- Unique identifier of this generated image, distinct from the generation job identifier. title: Image Id type: string image_url: description: Download URL. Poll the generation again to obtain a fresh URL. title: Image Url type: string width: description: Generated image width in pixels. exclusiveMinimum: 0 title: Width type: integer height: description: Generated image height in pixels. exclusiveMinimum: 0 title: Height type: integer seed: description: Actual seed used for this image. title: Seed type: integer required: - image_id - image_url - width - height - seed title: GeneratedImageResponse type: object StandardAPIErrorDetail: type: object properties: code: type: string description: Machine-readable error code example: unknown_node_type message: type: string description: Human-readable error message example: Unknown node type node_id: type: string description: Graph node id this error pertains to, if applicable port: type: string description: Port name on the node this error pertains to, if applicable path: type: string description: Field path within the item this error pertains to, if applicable required: - code - message 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.