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

# Create HyperFrames Render

> Renders a HyperFrames composition (an HTML+JS+assets project bundled as a .zip) into a video. Submit the project via `url`, `asset_id` (pre-uploaded via POST /v3/assets), or inline `base64`. Returns a `render_id` to poll via GET /v3/hyperframes/renders/{render_id}.



## OpenAPI

````yaml /openapi/external-api.json post /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
    description: >-
      Create videos from a prompt or an avatar, then list, fetch, deliver and
      delete them
  - name: Avatar
    description: >-
      Create avatars and looks, record consent, and generate with the Avatar 6
      model
  - name: Voice
    description: Text to speech, speech to speech, and voice cloning
  - name: Audio
    description: Music, sound effects, transcription, stem separation and audio analysis
  - name: Image
    description: Generate images
  - name: Video editing
    description: >-
      Translate, lipsync, clip, analyze and remove filler words or backgrounds
      from existing videos
  - name: Video Agent
    description: Create videos from a prompt with an agent that plans, writes and edits
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - name: HyperFrames
    description: Render HyperFrames compositions into video
  - name: Brand
    description: >-
      Brand kits (colors, fonts, logos) and brand glossaries (term translations
      and pronunciations)
  - name: Assets and folders
    description: Upload files and organize them in folders
  - name: Batches
    description: Submit and track videos, translations, lipsyncs and uploads in bulk
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Feedback
    description: Tell HeyGen how a generated result turned out
  - name: Account and usage
    description: Your account, the current API key, request logs and usage
paths:
  /v3/hyperframes/renders:
    post:
      tags:
        - HyperFrames
      summary: Create HyperFrames Render
      description: >-
        Renders a HyperFrames composition (an HTML+JS+assets project bundled as
        a .zip) into a video. Submit the project via `url`, `asset_id`
        (pre-uploaded via POST /v3/assets), or inline `base64`. Returns a
        `render_id` to poll via GET /v3/hyperframes/renders/{render_id}.
      operationId: createHyperframesRenderV3
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHyperframesRenderRequest'
      responses:
        '202':
          description: Accepted — submission acknowledged; poll for completion.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CreateHyperframesRenderResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: invalid_parameter
                  message: Composition zip is invalid or missing index.html.
                  param: project
                  doc_url: null
        '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
        '409':
          $ref: '#/components/responses/IdempotencyInProgress'
        '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:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Optional client-supplied key for safely retrying mutations. Subsequent
        calls within 24 hours that share this key replay the original response —
        even if the request body differs slightly (a warning is logged). A retry
        that arrives while the original is still in flight gets a 409
        `request_in_progress`. Keys must be 1–255 characters from
        `[A-Za-z0-9_:.-]`; a UUID is a safe default. Scope is per-endpoint and
        per-resource: the same key on a different route or path parameter is
        independent.
      schema:
        type: string
        pattern: ^[A-Za-z0-9_\-:.]{1,255}$
        maxLength: 255
        minLength: 1
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    CreateHyperframesRenderRequest:
      additionalProperties: false
      description: Request body for POST /v3/hyperframes/renders.
      properties:
        project:
          description: >-
            HyperFrames composition .zip — provide as {type: 'url', url: '...'},
            {type: 'asset_id', asset_id: '...'} (pre-uploaded via POST
            /v3/assets), or {type: 'base64', media_type: 'application/zip',
            data: '...'}. Zip must contain index.html at the root (or the path
            you set in `composition`).
          discriminator:
            mapping:
              asset_id: '#/components/schemas/AssetId'
              base64: '#/components/schemas/AssetBase64'
              url: '#/components/schemas/AssetUrl'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/AssetUrl'
            - $ref: '#/components/schemas/AssetId'
            - $ref: '#/components/schemas/AssetBase64'
          title: Project
        fps:
          anyOf:
            - maximum: 240
              minimum: 1
              type: integer
            - enum:
                - 24000/1001
                - 30000/1001
                - 60000/1001
              type: string
            - type: 'null'
          default: 30
          description: >-
            Output frames per second: a whole number from 1 to 240, or
            '24000/1001', '30000/1001' or '60000/1001' for 23.976, 29.97 or
            59.94. Free renders are limited to 60. Defaults to 30 if not
            provided.
          title: Fps
        quality:
          default: standard
          description: Render quality preset; higher quality is slower.
          enum:
            - draft
            - standard
            - high
          title: Quality
          type: string
        format:
          default: mp4
          description: Output container/codec.
          enum:
            - mp4
            - webm
            - mov
          title: Format
          type: string
        crf:
          anyOf:
            - maximum: 63
              minimum: 0
              type: integer
            - type: 'null'
          default: null
          description: >-
            Overrides the quality preset's constant rate factor (lower is higher
            quality and a larger file). Integer 0-51 for mp4, 0-63 for webm;
            ignored for mov. Omit to use the preset's CRF.
          title: Crf
        max_bitrate:
          anyOf:
            - pattern: ^[0-9]+(\.[0-9]+)?[kKmMgG]?$
              type: string
            - type: 'null'
          default: null
          description: >-
            Caps the video bitrate, in bits per second with an optional k, M or
            G suffix (e.g. '40M' or '12000k'). Bounds the file size of
            high-quality renders. mp4 only. Omit for no cap.
          title: Max Bitrate
        buffer_size:
          anyOf:
            - pattern: ^[0-9]+(\.[0-9]+)?[kKmMgG]?$
              type: string
            - type: 'null'
          default: null
          description: >-
            Rate-control buffer for `max_bitrate`, same form (e.g. '80M'). A
            larger buffer lets short peaks exceed the cap. Requires
            `max_bitrate`; defaults to twice `max_bitrate`.
          title: Buffer Size
        resolution:
          $ref: '#/components/schemas/HyperframesResolution'
          default: 1080p
          description: >-
            Output resolution tier. Defaults to '1080p'. Pass '4k' for 4K
            renders.
        aspect_ratio:
          $ref: '#/components/schemas/HyperframesAspectRatio'
          default: '16:9'
          description: >-
            Output aspect ratio. Defaults to '16:9' (landscape). Pass '9:16' for
            portrait, '1:1' for square, or '4:5' for a portrait feed post (1080p
            only).
        composition:
          anyOf:
            - maxLength: 512
              type: string
            - type: 'null'
          default: null
          description: >-
            Entry HTML file relative to the project root (e.g.
            compositions/intro.html). Defaults to index.html when omitted.
          title: Composition
        variables:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: >-
            Optional overrides for the composition's data-composition-variables.
            Use this to parameterise a single composition across multiple
            renders.
          title: Variables
        strict_variables:
          default: false
          description: >-
            When true, the renderer checks `variables` against the composition's
            data-composition-variables before drawing any frame. A name the
            composition does not declare, or a value of the wrong type, ends the
            render as failed with a `failure_message` naming the variable; the
            request itself is still accepted (202) and the failed render is not
            charged. When false (the default) names are not checked and an
            unknown one is ignored.
          title: Strict Variables
          type: boolean
        title:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          default: null
          description: Free-text label for the render; echoed back in detail responses.
          title: Title
        callback_id:
          anyOf:
            - maxLength: 256
              type: string
            - type: 'null'
          default: null
          description: Opaque client tracking ID, echoed back in webhook payloads.
          title: Callback Id
        callback_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Per-request HTTPS webhook URL the render fires when it terminates.
          title: Callback Url
        reverse_session_id:
          anyOf:
            - pattern: >-
                ^rvs_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
              type: string
            - type: 'null'
          default: null
          description: >-
            The `rvs_` session id from POST /v1/hyperframes/reverse/start when
            this render belongs to a reverse-any-video run. Recorded with the
            render for product analytics; it changes nothing about how the
            render runs.
          title: Reverse Session Id
      required:
        - project
      title: CreateHyperframesRenderRequest
      type: object
    CreateHyperframesRenderResponse:
      description: Response for POST /v3/hyperframes/renders.
      properties:
        render_id:
          description: >-
            HyperFrames render identifier — poll GET
            /v3/hyperframes/renders/{render_id} for status.
          title: Render Id
          type: string
      required:
        - render_id
      title: CreateHyperframesRenderResponse
      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'
        request_id:
          type: string
          description: >-
            Request identifier, also returned in the X-HeyGen-Request-Id
            response header. Include it when contacting support.
          example: 8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40
      required:
        - code
        - message
    AssetId:
      additionalProperties: false
      description: Asset input via HeyGen asset ID from the asset upload endpoint.
      properties:
        type:
          const: asset_id
          description: Input type discriminator
          title: Type
          type: string
        asset_id:
          description: >-
            HeyGen asset ID from an asset upload or import; not a third-party
            file ID.
          title: Asset Id
          type: string
      required:
        - type
        - asset_id
      title: AssetId
      type: object
    AssetBase64:
      additionalProperties: false
      description: Asset input via base64-encoded content.
      properties:
        type:
          const: base64
          description: Input type discriminator
          title: Type
          type: string
        media_type:
          description: MIME type of the encoded content (e.g. "image/png")
          title: Media Type
          type: string
        data:
          description: Base64-encoded file content
          title: Data
          type: string
      required:
        - type
        - media_type
        - data
      title: AssetBase64
      type: object
      x-mcp-visible: false
    AssetUrl:
      additionalProperties: false
      description: Asset input via publicly accessible HTTPS URL.
      properties:
        type:
          const: url
          description: Input type discriminator
          title: Type
          type: string
        url:
          description: >-
            Public http(s) URL HeyGen can download without auth or redirects.
            Not a local or sandbox path (/mnt/data/..., file://, sandbox:);
            upload such files and pass asset_id.
          title: Url
          type: string
      required:
        - type
        - url
      title: AssetUrl
      type: object
    HyperframesResolution:
      description: Output resolution tier.
      enum:
        - 1080p
        - 4k
      title: HyperframesResolution
      type: string
    HyperframesAspectRatio:
      description: |-
        Output aspect ratio.

        Supported ratios are ``16:9`` (landscape), ``9:16`` (portrait), ``1:1``
        (square), and ``4:5`` (portrait feed post, 1080p only).
      enum:
        - '16:9'
        - '9:16'
        - '1:1'
        - '4:5'
      title: HyperframesAspectRatio
      type: string
    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
  responses:
    IdempotencyInProgress:
      description: >-
        A prior request with this Idempotency-Key is still in progress. Wait for
        the original request to complete, then retry.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                $ref: '#/components/schemas/StandardAPIError'
          example:
            error:
              code: request_in_progress
              message: >-
                A request with this Idempotency-Key is already in progress.
                Retry shortly.
              param: null
              doc_url: null
  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.