Skip to main content
GET
/
v1
/
sessions
List Equos Sessions.
curl --request GET \
  --url https://api.equos.ai/v1/sessions \
  --header 'x-api-key: <api-key>'
{
  "skip": 123,
  "take": 123,
  "total": 123,
  "sessions": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "freemium": true,
      "name": "<string>",
      "provider": "<string>",
      "client": "<string>",
      "status": "<string>",
      "maxDuration": 123,
      "host": {
        "serverUrl": "<string>"
      },
      "avatarId": "<string>",
      "avatar": {
        "id": "<string>",
        "organizationId": "<string>",
        "identity": "<string>",
        "name": "<string>",
        "client": "<string>",
        "thumbnailUrl": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "agentId": "<string>",
      "agent": {
        "id": "<string>",
        "organizationId": "<string>",
        "name": "<string>",
        "provider": "openai",
        "client": "<string>",
        "config": {
          "instructions": "<string>",
          "model": "gpt-4o-realtime-preview",
          "voice": "alloy"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

take
number
default:20
Required range: x <= 50
skip
number
default:0
Required range: x >= 0
client
string

Response

200 - application/json
skip
number
required
take
number
required
total
number
required
sessions
object[]
required
I