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

# List HyperFrames Renders

> Returns a cursor-paginated list of HyperFrames renders in the account, newest first.



## OpenAPI

````yaml /openapi/external-api.json get /v3/hyperframes/renders
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: Avatar Realtime
    description: >-
      Low-latency streaming avatar sessions — create a stream, poll for its HLS
      URL, push text, consume per-word timestamps
  - 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)
  - name: HyperFrames
    description: Render HyperFrames composition zips into video — separate from /v3/videos
  - name: AI Clipping
    description: Turn long-form videos into ready-to-share short clips with captions
paths:
  /v3/hyperframes/renders:
    get:
      tags:
        - HyperFrames
      summary: List HyperFrames Renders
      description: >-
        Returns a cursor-paginated list of HyperFrames renders in the account,
        newest first.
      operationId: listHyperframesRendersV3
      parameters:
        - name: limit
          in: query
          required: false
          description: Maximum items per page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
        - name: token
          in: query
          required: false
          description: Opaque cursor token for the next page.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperframesRenderDetail'
                  has_more:
                    type: boolean
                    description: Whether more pages are available
                  next_token:
                    type:
                      - string
                      - 'null'
                    description: Opaque cursor for the next page
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: invalid_parameter
                  message: '''limit'' must be between 1 and 100.'
                  param: limit
                  doc_url: null
        '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
        '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:
    HyperframesRenderDetail:
      description: Detailed HyperFrames render resource.
      properties:
        render_id:
          description: Unique render identifier.
          title: Render Id
          type: string
        status:
          $ref: '#/components/schemas/HyperframesRenderStatus'
          description: Current lifecycle state.
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Caller-supplied free-text label.
          title: Title
        callback_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Caller-supplied client tracking ID.
          title: Callback Id
        video_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Presigned download URL for the rendered video. Present only when
            status is 'completed'.
          title: Video Url
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Presigned download URL for the auto-generated thumbnail.
          title: Thumbnail Url
        duration:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Video duration in seconds; null until completed.
          title: Duration
        fps:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Frames per second the render was created at.
          title: Fps
        quality:
          anyOf:
            - enum:
                - draft
                - standard
                - high
              type: string
            - type: 'null'
          default: null
          description: Render quality preset.
          title: Quality
        format:
          description: Output container/codec.
          enum:
            - mp4
            - webm
            - mov
          title: Format
          type: string
        resolution:
          anyOf:
            - $ref: '#/components/schemas/HyperframesResolution'
            - type: 'null'
          default: null
          description: Resolution tier, if one was set.
        aspect_ratio:
          anyOf:
            - $ref: '#/components/schemas/HyperframesAspectRatio'
            - type: 'null'
          default: null
          description: Aspect ratio, if one was set.
        composition:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Composition entry file path.
          title: Composition
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp when the render was created.
          title: Created At
        completed_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: >-
            Unix timestamp when the render terminated. Null until status is
            'completed' or 'failed'.
          title: Completed At
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Error description. Present only when status is 'failed'.
          title: Failure Message
      required:
        - render_id
        - status
        - format
      title: HyperframesRenderDetail
      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
    HyperframesRenderStatus:
      description: Lifecycle status of a HyperFrames render.
      enum:
        - queued
        - rendering
        - completed
        - failed
      title: HyperframesRenderStatus
      type: string
    HyperframesResolution:
      description: |-
        Output resolution tier.

        Pricing diverges only at 4K (1.5x multiplier). The render-pipeline value
        set is intentionally narrow at launch; 720p and other tiers will follow
        once the producer/CLI surface catches up.
      enum:
        - 1080p
        - 4k
      title: HyperframesResolution
      type: string
    HyperframesAspectRatio:
      description: >-
        Output aspect ratio.


        Only the three ratios already supported end-to-end by the render
        pipeline

        are exposed today: ``16:9`` (landscape), ``9:16`` (portrait), ``1:1``

        (square). ``auto`` and other social-media ratios (4:5, 5:4) are reserved

        for a follow-up PR that wires composition-dim inference at the
        controller

        boundary.
      enum:
        - '16:9'
        - '9:16'
        - '1:1'
      title: HyperframesAspectRatio
      type: string
  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.

````