Skip to main content
GET
https://api.agenthuman.com
/
v1
/
sessions
List Sessions
curl --request GET \
  --url https://api.agenthuman.com/v1/sessions \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "sessions": [
    {
      "session_id": "sess_01H3Z8G9YR3K2N5M6P7Q8W4T",
      "avatar": {
        "avatar_id": "avat_01H3Z8G9YR3K2N5M6P7Q8W4T",
        "name": "Professional Avatar",
        "url": "https://example.com/avatar.jpg"
      },
      "session_type": "webrtc_video",
      "status": "ended",
      "started_at": "2024-01-15T12:00:00Z",
      "ended_at": "2024-01-15T12:05:30Z",
      "expiration": "2024-01-15T14:35:00Z",
      "duration": 330,
      "created_at": "2024-01-15T12:00:00Z",
      "metadata": {
        "user_name": "John Doe"
      }
    },
    {
      "session_id": "sess_01H3Z8G9YR3K2N5M6P7Q8W5U",
      "avatar": {
        "avatar_id": "avat_01H3Z8G9YR3K2N5M6P7Q8W5U",
        "name": "Sales Avatar",
        "url": "https://example.com/avatars/sales.jpg"
      },
      "session_type": "webrtc_video",
      "status": "started",
      "started_at": "2024-01-15T14:00:00Z",
      "ended_at": null,
      "expiration": "2024-01-15T18:00:00Z",
      "duration": 90,
      "created_at": "2024-01-15T14:00:00Z",
      "metadata": {}
    }
  ]
}

​
Query Parameters

​
avatar_id
string
Filter sessions by avatar ID
​
status
string
default:"all"
Filter sessions by status. Options:
  • all - Return all sessions (default)
  • created - Return only created sessions (not started yet)
  • started - Return only active/started sessions
  • ended - Return only ended sessions

​
Response

​
success
boolean
Whether the request was successful
​
sessions
array
Array of session objects (See Session schema).
{
  "success": true,
  "sessions": [
    {
      "session_id": "sess_01H3Z8G9YR3K2N5M6P7Q8W4T",
      "avatar": {
        "avatar_id": "avat_01H3Z8G9YR3K2N5M6P7Q8W4T",
        "name": "Professional Avatar",
        "url": "https://example.com/avatar.jpg"
      },
      "session_type": "webrtc_video",
      "status": "ended",
      "started_at": "2024-01-15T12:00:00Z",
      "ended_at": "2024-01-15T12:05:30Z",
      "expiration": "2024-01-15T14:35:00Z",
      "duration": 330,
      "created_at": "2024-01-15T12:00:00Z",
      "metadata": {
        "user_name": "John Doe"
      }
    },
    {
      "session_id": "sess_01H3Z8G9YR3K2N5M6P7Q8W5U",
      "avatar": {
        "avatar_id": "avat_01H3Z8G9YR3K2N5M6P7Q8W5U",
        "name": "Sales Avatar",
        "url": "https://example.com/avatars/sales.jpg"
      },
      "session_type": "webrtc_video",
      "status": "started",
      "started_at": "2024-01-15T14:00:00Z",
      "ended_at": null,
      "expiration": "2024-01-15T18:00:00Z",
      "duration": 90,
      "created_at": "2024-01-15T14:00:00Z",
      "metadata": {}
    }
  ]
}
For active sessions (status = started), duration is calculated at request time (seconds since started_at).