API ReferenceSessions
/public/sessions
List sessions
List sessions
Query Parameters
pageIndex?integer
Format
int32pageSize?integer
Format
int32companionId?string
externalClientId?string
sessionType?string
Value in
"voip" | "sip" | "webrtc" | "websocket" | "kiosk"search?string
tags?
Header Parameters
X-API-Version?string
Response Body
curl -X GET "https://companion-api.napster.com/public/sessions"{
"items": [
{
"id": "string",
"companion": {
"id": "string",
"firstName": "string",
"lastName": "string",
"previewUrl": "string",
"userId": "string"
},
"functions": [
"string"
],
"mcp": {
"servers": [
"string"
],
"connectors": [
"string"
]
},
"knowledgeBase": {
"id": "string",
"name": "string"
},
"faqCollections": [
{
"id": "string",
"name": "string"
}
],
"companionId": "string",
"knowledgeBaseId": "string",
"faqIds": [
"string"
],
"externalClientId": "string",
"tags": {
"property1": "string",
"property2": "string"
},
"sessionType": "voip",
"modality": "audio",
"status": "pending",
"agent": {
"id": "string",
"name": "string"
},
"cost": 0,
"createdAt": 0,
"startedAt": 0,
"closedAt": 0,
"closeReason": "string"
}
],
"filteredCount": 0,
"totalCount": 0,
"pageIndex": 0,
"pageSize": 0,
"search": "string"
}{
"code": "string",
"description": "string",
"type": "failure",
"numericType": 0
}