Health
Avatar
Agent
Sessions
Get Equos Session by ID.
Copy
curl --request GET \
--url https://api.equos.ai/v1/sessions/{id} \
--header 'x-api-key: <api-key>'Copy
{
"id": "<string>",
"organizationId": "<string>",
"freemium": true,
"name": "<string>",
"provider": "<string>",
"status": "<string>",
"host": {
"serverUrl": "<string>"
},
"avatar": {
"id": "<string>",
"organizationId": "<string>",
"identity": "<string>",
"name": "<string>",
"description": "<string>",
"thumbnailUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"agentId": {},
"agent": {}
},
"startedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"maxDuration": 123,
"additionalCtx": "<string>",
"templateVars": {},
"avatarId": "<string>",
"agentId": "<string>",
"agent": {
"id": "<string>",
"organizationId": "<string>",
"provider": "openai",
"search": true,
"emotions": true,
"memory": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"client": "<string>",
"model": "gemini-2.5-flash-native-audio-preview-09-2025",
"voice": "Puck",
"instructions": "<string>",
"greetingMsg": "<string>",
"remoteId": "<string>"
},
"remoteAgentIdentity": {},
"transcript": {},
"endedAt": "2023-11-07T05:31:56Z"
}Sessions
Get Equos Session by ID.
GET
/
v1
/
sessions
/
{id}
Get Equos Session by ID.
Copy
curl --request GET \
--url https://api.equos.ai/v1/sessions/{id} \
--header 'x-api-key: <api-key>'Copy
{
"id": "<string>",
"organizationId": "<string>",
"freemium": true,
"name": "<string>",
"provider": "<string>",
"status": "<string>",
"host": {
"serverUrl": "<string>"
},
"avatar": {
"id": "<string>",
"organizationId": "<string>",
"identity": "<string>",
"name": "<string>",
"description": "<string>",
"thumbnailUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"agentId": {},
"agent": {}
},
"startedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"maxDuration": 123,
"additionalCtx": "<string>",
"templateVars": {},
"avatarId": "<string>",
"agentId": "<string>",
"agent": {
"id": "<string>",
"organizationId": "<string>",
"provider": "openai",
"search": true,
"emotions": true,
"memory": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"client": "<string>",
"model": "gemini-2.5-flash-native-audio-preview-09-2025",
"voice": "Puck",
"instructions": "<string>",
"greetingMsg": "<string>",
"remoteId": "<string>"
},
"remoteAgentIdentity": {},
"transcript": {},
"endedAt": "2023-11-07T05:31:56Z"
}Authorizations
Path Parameters
Equos Session ID
Response
200 - application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
openai, gemini, elevenlabs Available options:
gemini-2.5-flash-native-audio-preview-09-2025, gpt-4o-realtime-preview, gpt-realtime Available options:
Puck, Charon, Kore, Fenrir, Aoede, Leda, Orus, Zephyr, Sulafat, Sadachbia, Sadaltager, Vindemiatrix, Zubenelgenubi, Achird, Pulcherrima, Gacrux, Schedar, Alnilam, Achernar, Laomedeia, Rasalgethi, Algenib, Erinome, Despina, Algieba, Umbriel, Iapetus, Enceladus, Autonoe, Callirrhoe, alloy, marin, cedar, ash, ballad, coral, echo, sage, shimmer, verse Start an Equos avatar sesssion.End an equos session. Returns null if already stopped or session was not found.
⌘I