> ## 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 Session Videos

> Returns all videos produced within a Video Agent session, sorted newest-first.



## OpenAPI

````yaml /openapi/external-api.json get /v3/video-agents/{session_id}/videos
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/video-agents/{session_id}/videos:
    get:
      tags:
        - Video Agent
      summary: List Session Videos
      description: >-
        Returns all videos produced within a Video Agent session, sorted
        newest-first.
      operationId: listVideoAgentSessionVideos
      parameters:
        - name: session_id
          in: path
          required: true
          schema:
            type: string
          description: Session ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VideoDetail'
                  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'
        '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: not_found
                  message: Session not found.
                  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:
    VideoDetail:
      description: |-
        Video resource returned by list and detail endpoints.

        If ``output_language`` is present the video is a translated video;
        otherwise it is a generated video.
      properties:
        id:
          description: Unique video identifier
          examples:
            - v_abc123def456
          title: Id
          type: string
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Video title
          examples:
            - My Generated Video
          title: Title
        status:
          $ref: '#/components/schemas/VideoStatus'
          description: Current video status
          examples:
            - completed
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp of creation
          examples:
            - 1711929600
          title: Created At
        completed_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp when video generation finished
          examples:
            - 1711930200
          title: Completed At
        video_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Presigned URL to download the video file
          examples:
            - https://files.heygen.ai/video/abc123.mp4
          title: Video Url
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: URL to video thumbnail image
          examples:
            - https://files.heygen.ai/thumb/abc123.jpg
          title: Thumbnail Url
        gif_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: URL to animated GIF preview
          examples:
            - https://files.heygen.ai/gif/abc123.gif
          title: Gif Url
        captioned_video_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Presigned URL to download the video file with captions burned in
          examples:
            - https://files.heygen.ai/video/abc123_captioned.mp4
          title: Captioned Video Url
        subtitle_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Presigned URL to download the SRT subtitle file
          examples:
            - https://files.heygen.ai/srt/abc123.srt
          title: Subtitle Url
        duration:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Video duration in seconds
          examples:
            - 30.5
          title: Duration
        folder_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: ID of containing folder
          examples:
            - folder_abc123
          title: Folder Id
        output_language:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: BCP-47 output language code. Present only for translated videos.
          examples:
            - en-US
          title: Output Language
        failure_code:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Machine-readable failure reason. Only present when status is failed.
          examples:
            - rendering_failed
          title: Failure Code
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Human-readable failure description. Only present when status is
            failed.
          examples:
            - Avatar rendering timed out
          title: Failure Message
        video_page_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: URL to the video page in the HeyGen app
          examples:
            - https://app.heygen.com/video/abc123
          title: Video Page Url
        delivery:
          anyOf:
            - items:
                $ref: '#/components/schemas/FileDeliveryStatus'
              type: array
            - type: 'null'
          default: null
          description: >-
            Upload status of each file sent to your own storage with
            output_upload. Present on the single-video GET when the request that
            created the video sent output_upload.
          title: Delivery
          x-cli-visible: false
          x-mcp-visible: false
      required:
        - id
        - status
      title: VideoDetail
      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
    VideoStatus:
      enum:
        - pending
        - processing
        - completed
        - failed
      title: VideoStatus
      type: string
    FileDeliveryStatus:
      properties:
        artifact:
          $ref: '#/components/schemas/DeliveryArtifact'
          description: 'Which file: video, captions or thumbnail.'
        status:
          $ref: '#/components/schemas/DeliveryStatus'
          description: >-
            pending, in_progress, succeeded or failed. A file left unsent
            because its video failed to render reports failed (source_missing).
        target_host:
          description: >-
            Host of the upload URL the file goes to. The URL itself is never
            returned.
          title: Target Host
          type: string
        size_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Bytes uploaded. Set when status is succeeded.
          title: Size Bytes
        error_code:
          anyOf:
            - $ref: '#/components/schemas/DeliveryErrorCode'
            - type: 'null'
          default: null
          description: Why the upload failed. Set when status is failed.
        completed_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp when the upload succeeded or failed.
          title: Completed At
      required:
        - artifact
        - status
        - target_host
      title: FileDeliveryStatus
      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
    DeliveryArtifact:
      enum:
        - video
        - captions
        - thumbnail
      title: DeliveryArtifact
      type: string
    DeliveryStatus:
      enum:
        - pending
        - in_progress
        - succeeded
        - failed
      title: DeliveryStatus
      type: string
    DeliveryErrorCode:
      description: >-
        The public reason a delivery failed, stored in
        ``video_deliveries.error_code`` and sent in webhooks.
      enum:
        - upload_url_expired
        - upload_rejected
        - upload_target_not_found
        - output_too_large
        - provider_unavailable
        - source_missing
        - internal_error
      title: DeliveryErrorCode
      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.