API ReferenceCompanions
/public/napster-companions
This endpoint is deprecated and may be removed in a future version. Use GET /public/companions/napster-stock instead.
Authorization
ApiKeyAuth X-Api-Key<token>
API key for authentication. Passed as a header on every request.
In: header
Query Parameters
ethnicity?string
gender?string
Value in
"male" | "female" | "nonBinary"search?string
tags?
pageIndex?integer
Format
int32pageSize?integer
Format
int32Header Parameters
X-API-Version?string
Response Body
curl -X GET "https://companion-api.napster.com/public/napster-companions"{
"items": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"previewUrl": "string",
"videoLoopUrl": "string",
"ethnicity": "string",
"gender": "string",
"headline": "string",
"tags": {
"property1": "string",
"property2": "string"
},
"status": "pending",
"createdAt": 0,
"externalClientId": "string",
"versions": [
"v1"
]
}
],
"filteredCount": 0,
"totalCount": 0,
"pageIndex": 0,
"pageSize": 0,
"search": "string"
}/public/companions GET
Returns a list of companions that you have created in the current project. These are your custom companions, not Napster's pre-built stock companions.
/public/companions/napster-stock GET
Returns a list of Napster's pre-built stock companions. These are ready-made companions provided by Napster that you can use as starting points or deploy directly.