API ReferenceRecordings

/public/companions/{companionId}/recordings

Generate a pre-recorded video of a companion's avatar speaking

POST
/public/companions/{companionId}/recordings

Generate a pre-recorded video of a companion's avatar speaking

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 POST "https://companion-api.napster.com/public/companions/string/recordings" \  -H "Content-Type: application/json" \  -d '{    "provider": "openAi",    "voiceId": "string",    "text": "string"  }'
{
  "text": "string",
  "id": "string",
  "provider": "openAi",
  "voiceId": "string",
  "previewUrl": "string",
  "status": "pending",
  "createdAt": 0,
  "updatedAt": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}