API ReferenceRecordings

/public/companions/{companionId}/recordings

List a companion's pre-recorded videos

GET
/public/companions/{companionId}/recordings

List a companion's pre-recorded videos

Path Parameters

companionId*string

Query Parameters

provider?string
Value in"openAi" | "elevenLabs"
voiceId?string
search?string
tags?
channel?string
Value in"voip" | "sip" | "webrtc" | "websocket" | "kiosk"
pageIndex?integer
Formatint32
pageSize?integer
Formatint32

Header Parameters

X-API-Version?string

Response Body

curl -X GET "https://companion-api.napster.com/public/companions/string/recordings"
{
  "items": [
    {
      "id": "string",
      "provider": "openAi",
      "voiceId": "string",
      "previewUrl": "string",
      "status": "pending",
      "createdAt": 0,
      "updatedAt": 0,
      "tags": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "filteredCount": 0,
  "totalCount": 0,
  "pageIndex": 0,
  "pageSize": 0,
  "search": "string"
}