> ## 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 Video

> Get a HeyGen Video generation in the caller's workspace. Status is pending, processing, completed, failed, or cancelled. Completed results include a fresh video_url, duration, aspect_ratio, dimensions, and seed when available. Failed and cancelled results include failure_code and failure_message. Poll again to refresh an expired download URL. Missing videos and videos from another workspace return the same 404.



## OpenAPI

````yaml /openapi/external-api.json get /v3/models/videos/{video_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/videos/{video_id}:
    get:
      tags:
        - Models
      summary: Get HeyGen Video
      description: >-
        Get a HeyGen Video generation in the caller's workspace. Status is
        pending, processing, completed, failed, or cancelled. Completed results
        include a fresh video_url, duration, aspect_ratio, dimensions, and seed
        when available. Failed and cancelled results include failure_code and
        failure_message. Poll again to refresh an expired download URL. Missing
        videos and videos from another workspace return the same 404.
      operationId: getModelVideo
      parameters:
        - name: video_id
          in: path
          required: true
          schema:
            type: string
          description: Unique video identifier
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ModelVideoResponse'
        '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: Video generation request 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:
    ModelVideoResponse:
      properties:
        video_id:
          description: Generated video identifier.
          title: Video Id
          type: string
        status:
          description: Current generation status.
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
          title: Status
          type: string
        model:
          $ref: '#/components/schemas/VideoGenerationModel'
          description: Requested video generation model.
        created_at:
          description: Request creation time as Unix seconds.
          title: Created At
          type: integer
        video_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Download URL, present when completed. Poll again to obtain a fresh
            URL.
          title: Video Url
        duration:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Generated video duration in seconds, present when completed.
          title: Duration
        aspect_ratio:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Output aspect ratio. Adaptive outputs report the actual width:height
            ratio after pixel alignment.
          title: Aspect Ratio
        width:
          anyOf:
            - exclusiveMinimum: 0
              type: integer
            - type: 'null'
          default: null
          description: >-
            Actual output width in pixels, present when reported by the
            renderer.
          title: Width
        height:
          anyOf:
            - exclusiveMinimum: 0
              type: integer
            - type: 'null'
          default: null
          description: >-
            Actual output height in pixels, present when reported by the
            renderer.
          title: Height
        seed:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Generation seed, present when completed.
          title: Seed
        timings:
          anyOf:
            - $ref: '#/components/schemas/ModelVideoTimings'
            - type: 'null'
          default: null
          description: Generation timing in seconds, when reported by the renderer.
        failure_code:
          anyOf:
            - enum:
                - generation_failed
                - generation_cancelled
              type: string
            - type: 'null'
          default: null
          description: Failure code, present when failed or cancelled.
          title: Failure Code
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Failure explanation, present when failed or cancelled.
          title: Failure Message
      required:
        - video_id
        - status
        - model
        - created_at
      title: ModelVideoResponse
      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
    VideoGenerationModel:
      enum:
        - heygen-video-1
      title: VideoGenerationModel
      type: string
    ModelVideoTimings:
      properties:
        inference:
          description: >-
            Diffusion transformer execution time in seconds. Excludes other
            inference stages, encoding, and queueing.
          minimum: 0
          title: Inference
          type: number
      required:
        - inference
      title: ModelVideoTimings
      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.

````