> ## 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 AI Clipping

> Submit a source video and return a job id immediately. The job runs asynchronously and produces one or more short clips. Highlights are picked from the spoken dialogue, so music-only or silent videos fail. Clips are 20 seconds or longer; output_settings.duration_types picks the length bands (30, 60, 180, long). Check progress with GET /v3/ai-clipping/{job_id}, or subscribe to the ai_clipping.success / ai_clipping.fail webhooks.



## OpenAPI

````yaml /openapi/external-api.json post /v3/ai-clipping
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/ai-clipping:
    post:
      tags:
        - Video editing
      summary: Create AI Clipping
      description: >-
        Submit a source video and return a job id immediately. The job runs
        asynchronously and produces one or more short clips. Highlights are
        picked from the spoken dialogue, so music-only or silent videos fail.
        Clips are 20 seconds or longer; output_settings.duration_types picks the
        length bands (30, 60, 180, long). Check progress with GET
        /v3/ai-clipping/{job_id}, or subscribe to the ai_clipping.success /
        ai_clipping.fail webhooks.
      operationId: createAiClippingV3
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAiClippingRequest'
      responses:
        '202':
          description: Accepted — submission acknowledged; poll for completion.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CreateAiClippingResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: invalid_parameter
                  message: Source video URL is unsupported or unreachable.
                  param: video
                  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:
    CreateAiClippingRequest:
      additionalProperties: false
      description: Request body for POST /v3/ai-clipping.
      properties:
        video:
          description: Source video. Either a URL or an asset_id from POST /v3/assets.
          discriminator:
            mapping:
              asset_id: '#/components/schemas/AssetId'
              url: '#/components/schemas/AssetUrl'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/AssetUrl'
            - $ref: '#/components/schemas/AssetId'
          title: Video
        title:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          default: null
          description: Title for the job. Defaults to the source video's title if omitted.
          title: Title
        input_language:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            ISO-639-1 source language code (e.g. 'en', 'es'). Omit for
            auto-detect.
          title: Input Language
        output_settings:
          $ref: '#/components/schemas/HighlightOutputSettings'
          description: >-
            Configuration for the produced clips (duration mix, aspect ratio,
            captions, etc.).
        callback_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            HTTPS URL to receive per-job webhook callbacks. Mirrors
            /v3/video-translations callback_url. Per-job callback_url deliveries
            are NOT HMAC-signed: authenticate them by verifying TLS and matching
            the echoed callback_id, and do not trust an unverified body. To
            receive a signed payload, register a webhook endpoint with a secret
            (the signature header is sent only to registered endpoints).
          title: Callback Url
        callback_id:
          anyOf:
            - maxLength: 128
              type: string
            - type: 'null'
          default: null
          description: >-
            Opaque client identifier echoed verbatim in webhook payloads.
            Mirrors /v3/video-translations callback_id.
          title: Callback Id
      required:
        - video
      title: CreateAiClippingRequest
      type: object
    CreateAiClippingResponse:
      description: >-
        Response for POST /v3/ai-clipping. Mirrors the v3 single-ID create
        shape.
      properties:
        ai_clipping_id:
          description: Unique job identifier. Use with all other endpoints.
          title: Ai Clipping Id
          type: string
      required:
        - ai_clipping_id
      title: CreateAiClippingResponse
      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
    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
    HighlightOutputSettings:
      additionalProperties: false
      description: Configuration for the clips the job will produce.
      properties:
        duration_types:
          description: >-
            One or more target clip length bands. Each produced clip is matched
            to one of the selected bands.
          items:
            $ref: '#/components/schemas/OutputDuration'
          maxItems: 4
          minItems: 1
          title: Duration Types
          type: array
        aspect_ratio:
          $ref: '#/components/schemas/OutputAspectRatio'
          default: portrait
          description: >-
            Aspect ratio for all produced clips. Default 'portrait' (9:16,
            social-ready).
        captions:
          default: true
          description: Burn captions into the clips. Set false to disable.
          title: Captions
          type: boolean
        caption_style:
          $ref: '#/components/schemas/CaptionStylePreset'
          default: outline_classic
          description: >-
            Named caption style preset (e.g. 'outline_classic', 'bold').
            Defaults to 'outline_classic'. Null or unrecognized values fall back
            to the default.
        prompt:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          default: null
          description: >-
            Optional editorial guidance for the highlight model. Max 500
            characters.
          title: Prompt
      title: HighlightOutputSettings
      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
    OutputDuration:
      description: >-
        Target clip length band: 30 = 20-30s, 60 = 30-60s, 180 = 60-120s, long =
        over 120s.
      enum:
        - '30'
        - '60'
        - '180'
        - long
      title: OutputDuration
      type: string
    OutputAspectRatio:
      description: Output aspect ratio for produced clips.
      enum:
        - landscape
        - portrait
        - square
      title: OutputAspectRatio
      type: string
    CaptionStylePreset:
      description: Available caption style presets.
      enum:
        - subtle_gray
        - shadow_mint
        - subtle_cyan
        - stamp_red
        - retro_gold
        - block_dark
        - racing
        - modern_dark
        - modern_boxed
        - chunky
        - clean
        - shadow_lime
        - tag_yellow
        - pop_purple
        - spotlight
        - outline_classic
        - exotic
        - golden
        - simple
        - pop_single
        - energy
        - bold
        - elegant
        - neon_pink
      title: CaptionStylePreset
      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.