List Session Videos

cURL

curl --request GET \
  --url https://api.heygen.com/v3/video-agents/{session_id}/videos \
  --header 'x-api-key: <api-key>'

Response Codes

• 200: Successful response
• 400: Bad Request
• 401: Unauthorized
• 404: Not Found
• 429: Too Many Requests

{
  "data": [
    {
      "id": "<string>",
      "status": "pending",
      "title": "My Generated Video",
      "created_at": 1711929600,
      "completed_at": 1711930200,
      "video_url": "https://files.heygen.ai/video/abc123.mp4",
      "thumbnail_url": "https://files.heygen.ai/thumb/abc123.jpg",
      "gif_url": "https://files.heygen.ai/gif/abc123.gif",
      "captioned_video_url": "https://files.heygen.ai/video/abc123_captioned.mp4",
      "subtitle_url": "https://files.heygen.ai/srt/abc123.srt",
      "duration": 30.5,
      "folder_id": "folder_abc123",
      "output_language": "en-US",
      "failure_code": "rendering_failed",
      "failure_message": "Avatar rendering timed out",
      "video_page_url": "https://app.heygen.com/video/abc123"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Authorizations

• ApiKeyAuth
  x-api-key
  string, header, required
  Obtain from your HeyGen dashboard.

Path Parameters

• session_id
  string, required
  Session ID

Response Structure

• data: VideoDetail · object[]
• has_more: boolean
  Whether more pages are available
• next_token: string | null
  Opaque cursor for the next page.