> ## 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 Lipsync Batch

> Submits up to 100 lipsync payloads as one batch, and items run independently. Returns 202 with a `batch_id`; poll GET /v3/lipsyncs/batches/{batch_id}. Send an Idempotency-Key to make retries safe.



## OpenAPI

````yaml /openapi/external-api.json post /v3/lipsyncs/batches
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/lipsyncs/batches:
    post:
      tags:
        - Batches
      summary: Create Lipsync Batch
      description: >-
        Submits up to 100 lipsync payloads as one batch, and items run
        independently. Returns 202 with a `batch_id`; poll GET
        /v3/lipsyncs/batches/{batch_id}. Send an Idempotency-Key to make retries
        safe.
      operationId: createLipsyncBatchV3
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLipsyncBatchRequest'
      responses:
        '202':
          description: Accepted — submission acknowledged; poll for completion.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CreateLipsyncBatchResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: invalid_parameter
                  message: Invalid payload(s) at index 3.
                  param: lipsyncs
                  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:
    CreateLipsyncBatchRequest:
      additionalProperties: false
      properties:
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Display name for the batch, shown in the HeyGen app.
          title: Title
        callback_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Webhook URL invoked once when every item in the batch reaches a
            terminal state.
          title: Callback Url
        lipsyncs:
          description: >-
            Lipsync payloads, identical in shape to POST /v3/lipsyncs. Each
            entry becomes exactly one batch item (no expansion); the item count
            is capped at 100.
          items:
            $ref: '#/components/schemas/CreateLipsyncRequest'
          maxItems: 100
          minItems: 1
          title: Lipsyncs
          type: array
      required:
        - lipsyncs
      title: CreateLipsyncBatchRequest
      type: object
    CreateLipsyncBatchResponse:
      properties:
        batch_id:
          description: >-
            Identifier of the created batch. Poll GET
            /v3/lipsyncs/batches/{batch_id} for progress.
          title: Batch Id
          type: string
      required:
        - batch_id
      title: CreateLipsyncBatchResponse
      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
    CreateLipsyncRequest:
      additionalProperties: false
      description: Request body for POST /v3/lipsyncs.
      properties:
        video:
          description: >-
            Source video — provide as {type: 'url', url: '...'} or {type:
            'asset_id', asset_id: '...'}
          discriminator:
            mapping:
              asset_id: '#/components/schemas/AssetId'
              url: '#/components/schemas/AssetUrl'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/AssetUrl'
            - $ref: '#/components/schemas/AssetId'
          title: Video
        audio:
          description: >-
            Replacement audio — provide as {type: 'url', url: '...'} or {type:
            'asset_id', asset_id: '...'}
          discriminator:
            mapping:
              asset_id: '#/components/schemas/AssetId'
              url: '#/components/schemas/AssetUrl'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/AssetUrl'
            - $ref: '#/components/schemas/AssetId'
          title: Audio
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Title for the lipsync job
          title: Title
        mode:
          $ref: '#/components/schemas/VideoTranslationMode'
          default: speed
          description: >-
            Quality mode: 'speed' (faster) or 'precision' (higher quality, uses
            avatar inference)
        callback_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Webhook URL for completion notifications
          title: Callback Url
        callback_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: ID included in webhook payload
          title: Callback Id
        enable_caption:
          default: false
          deprecated: true
          description: >-
            Deprecated and ignored: captions are always generated; whether to
            display them is a download-side choice.
          title: Enable Caption
          type: boolean
        keep_the_same_format:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Preserve the source video's encoding specs (resolution, bitrate).
          title: Keep The Same Format
        enable_dynamic_duration:
          default: true
          description: Allow dynamic duration adjustment
          title: Enable Dynamic Duration
          type: boolean
        disable_music_track:
          default: false
          description: Remove background music
          title: Disable Music Track
          type: boolean
        enable_speech_enhancement:
          default: false
          description: Enhance speech quality
          title: Enable Speech Enhancement
          type: boolean
        enable_watermark:
          default: false
          description: Add watermark to output
          title: Enable Watermark
          type: boolean
        start_time:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Start time in seconds for partial lipsync
          title: Start Time
        end_time:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: End time in seconds for partial lipsync
          title: End Time
        fps_mode:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: 'Frame rate mode: ''vfr'', ''cfr'', or ''passthrough''.'
          title: Fps Mode
        folder_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Destination folder ID in the caller's workspace, for example one
            returned by POST /v3/folders. Omit, pass null, or pass an empty
            string to place the result at the workspace root. The id must name a
            folder that is not in the trash and that the caller can write to.
            Assets library folders are accepted, but the HeyGen app files only
            assets in them, so a result placed there may not appear in the
            Assets library view. An unknown id, a folder in another workspace, a
            project of another kind such as a brand kit, or a trashed folder is
            rejected with 404 before anything is created.
          title: Folder Id
      required:
        - video
        - audio
      title: CreateLipsyncRequest
      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
    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
    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
    VideoTranslationMode:
      enum:
        - speed
        - precision
      title: VideoTranslationMode
      type: string
  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.