API ReferenceCompanions
/public/companions/{companionId}
Authorization
ApiKeyAuth X-Api-Key<token>
API key for authentication. Passed as a header on every request.
In: header
Path Parameters
companionId*string
Header Parameters
X-API-Version?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PATCH "https://companion-api.napster.com/public/companions/string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "string",
"firstName": "string",
"lastName": "string",
"previewUrl": "string",
"videoLoopUrl": "string",
"gender": "string",
"ethnicity": "string",
"headline": "string",
"assistantPrompt": "string",
"status": "pending",
"tags": {
"property1": "string",
"property2": "string"
},
"createdAt": 0,
"externalClientId": "string",
"customVoices": [
{
"id": "string"
}
],
"versions": [
"v1"
]
}{
"code": "string",
"description": "string",
"type": "failure",
"numericType": 0
}