List Video Agent Sessions

cURL

curl --request GET \
  --url 'https://api.heygen.com/v3/video-agents?limit=20' \
  --header 'x-api-key: <api-key>'

Responses

200

{
  "data": [
    {
      "session_id": "<string>",
      "created_at": 123,
      "title": "<string>"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ApiKeyAuth
x-api-key

  • String
  • Header
  • Required

HeyGen API key. Obtain from your HeyGen dashboard.

Query Parameters

  • limit

    • Integer
    • Default: 20
    • Results per page (1-100). Required range: 1 <= x <= 100

  • token

    • String
    • Opaque cursor token for the next page. Obtained from next_token in a previous response.

Response

200

  • application/json

Successful response

  • data
    • SessionListItem: object[]

Attributes

  • has_more

    • Boolean
    • Whether more pages are available

  • next_token

    • String | null
    • Opaque cursor for the next page