get https://api.heygen.com/v2/streaming.list
This endpoint retrieves a paginated history of all streaming sessions, including metadata such as session duration, timestamps, and other details.
Interactive Avatar is getting upgraded to LiveAvatar! Now with its own website and app. Learn more
We recommend integrating directly with LiveAvatar instead. Docs
Response Body
| Field | Type | Description |
|---|---|---|
| total | numbers | Total numbers of sessions |
| page | numbers | Page number |
| page_size | numbers | Page size |
| next_pagination_token | string | Token for next page |
| data | List of sessions. | |
| data[].session_id | string | Unique identifier for the session. |
| data[].status | string | status of this session (new/connecting/connected) |
| data[].created_at | numbers | Creation time (Unix timestamp) for the session |
| data[].api_key_type | string | API key type |
| data[].duration | numbers | Session duration in seconds |
| data[].avatar_id | string | Session avatar identifier |
| data[].voice_name | string | Session voice name |