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

# Complete Asset Upload

> Finalize a direct-to-S3 upload into a reusable asset. Call after the upload PUT returns 200. Idempotent: repeated calls return the same finalized asset.



## OpenAPI

````yaml /openapi/external-api.json post /v3/assets/{asset_id}/complete
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/assets/{asset_id}/complete:
    post:
      tags:
        - Assets and folders
      summary: Complete Asset Upload
      description: >-
        Finalize a direct-to-S3 upload into a reusable asset. Call after the
        upload PUT returns 200. Idempotent: repeated calls return the same
        finalized asset.
      operationId: completeAssetUpload
      parameters:
        - name: asset_id
          in: path
          required: true
          schema:
            type: string
          description: Unique asset identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompleteAssetUploadRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CompleteAssetUploadResponse'
        '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: asset_not_found
                  message: Asset not found.
                  param: null
                  doc_url: null
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: conflict
                  message: >-
                    Uploaded object not found yet. Retry after the upload PUT
                    returns 200.
                  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:
    CompleteAssetUploadRequest:
      description: Finalize a presigned upload (POST /v3/assets/{asset_id}/complete).
      properties:
        checksum_sha256:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Optional SHA256 (hex) cross-check.
          title: Checksum Sha256
        multipart_upload_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: 'For an upload in parts: from the create response.'
          title: Multipart Upload Id
          x-mcp-visible: false
        parts:
          anyOf:
            - items:
                $ref: '#/components/schemas/CompletedPart'
              type: array
            - type: 'null'
          default: null
          description: >-
            For an upload in parts: every part with the ETag S3 answered. They
            are joined, then checked like a single PUT.
          title: Parts
          x-mcp-visible: false
      title: CompleteAssetUploadRequest
      type: object
    CompleteAssetUploadResponse:
      description: Result of finalizing an upload.
      properties:
        asset_id:
          description: The reusable asset identifier.
          title: Asset Id
          type: string
        url:
          description: Public URL of the finalized asset.
          title: Url
          type: string
        mime_type:
          description: MIME type detected from the stored bytes.
          title: Mime Type
          type: string
        size_bytes:
          description: Size of the stored object in bytes.
          title: Size Bytes
          type: integer
        status:
          const: processing
          description: Asset status, e.g. 'processing'.
          title: Status
          type: string
      required:
        - asset_id
        - url
        - mime_type
        - size_bytes
        - status
      title: CompleteAssetUploadResponse
      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
    CompletedPart:
      description: A part to join at completion.
      properties:
        part_number:
          maximum: 10000
          minimum: 1
          title: Part Number
          type: integer
        etag:
          description: ETag S3 answered for the part.
          title: Etag
          type: string
      required:
        - part_number
        - etag
      title: CompletedPart
      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.