๐Ÿ† Omniagent API Hackathon ยท Judging underway โ€” Winners announced June 15
API ReferenceCompanions

/public/companions/{companionId}

GET
/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

Response Body

curl -X GET "https://companion-api.napster.com/public/companions/string"
{
  "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"
  ]
}