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

> Returns a cursor-paginated list of AI clip jobs in the authenticated user's workspace, newest first.



## OpenAPI

````yaml /openapi/external-api.json get /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:
    get:
      tags:
        - Video editing
      summary: List AI Clipping
      description: >-
        Returns a cursor-paginated list of AI clip jobs in the authenticated
        user's workspace, newest first.
      operationId: listAiClippingV3
      parameters:
        - name: limit
          in: query
          required: false
          description: >-
            Maximum number of items per page. Defaults to 10 (lower than other
            v3 lists) because each item embeds its full clips array.
          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/AiClippingDetail'
                  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: unauthorized
                  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:
    AiClippingDetail:
      description: Full job resource returned by Get, List, and webhook payloads.
      properties:
        id:
          description: Unique job identifier.
          title: Id
          type: string
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Display title.
          title: Title
        status:
          $ref: '#/components/schemas/JobStatus'
          description: Job lifecycle status.
        input_language:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Detected or supplied source language code.
          title: Input Language
        source_duration:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Duration of the source video in seconds.
          title: Source Duration
        output_settings:
          anyOf:
            - $ref: '#/components/schemas/HighlightOutputSettings'
            - type: 'null'
          default: null
          description: Currently omitted from Get, List, and webhook responses.
        clips:
          description: Produced clips. Empty until the job's first clip is rendered.
          items:
            $ref: '#/components/schemas/Clip'
          title: Clips
          type: array
        progress:
          default: 0
          description: >-
            Approximate progress (0-100). 100 when all clips completed. GET
            /v3/ai-clipping/{id} returns live in-flight progress; the list
            endpoint reports a coarse value (0 until completed, then 100). Poll
            the single-get endpoint for granular progress.
          maximum: 100
          minimum: 0
          title: Progress
          type: integer
        callback_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Client-provided callback ID.
          title: Callback Id
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp (seconds) of job creation.
          title: Created At
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Error description. Only present when status=failed.
          title: Failure Message
      required:
        - id
        - status
      title: AiClippingDetail
      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
    JobStatus:
      description: Public job lifecycle.
      enum:
        - pending
        - running
        - completed
        - failed
        - cancelled
      title: JobStatus
      type: string
    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
    Clip:
      description: A single produced clip. Returned inline inside AiClippingDetail.
      properties:
        id:
          description: Unique clip identifier.
          title: Id
          type: string
        status:
          $ref: '#/components/schemas/ClipStatus'
          description: Per-clip status.
        duration_seconds:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Final clip duration in seconds. Null until status=completed.
          title: Duration Seconds
        aspect_ratio:
          anyOf:
            - $ref: '#/components/schemas/OutputAspectRatio'
            - type: 'null'
          default: null
          description: Clip aspect ratio. Null until status=completed.
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Model-generated clip title.
          title: Title
        virality_score:
          anyOf:
            - maximum: 100
              minimum: 0
              type: integer
            - type: 'null'
          default: null
          description: Model-predicted virality score (0-100). Null until status=completed.
          title: Virality Score
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Presigned thumbnail URL. Null until status=completed.
          title: Thumbnail Url
        video_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Presigned MP4 download URL. Null until status=completed.
          title: Video Url
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Per-clip failure description. Currently always null.
          title: Failure Message
      required:
        - id
        - status
      title: Clip
      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
    ClipStatus:
      description: >-
        Per-clip lifecycle. A job can produce N clips, each completing
        separately.
      enum:
        - pending
        - completed
        - failed
      title: ClipStatus
      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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.