You can generate a pre-recorded video of your Omniagent's avatar speaking text you provide — a video greeting, a training clip, an onboarding walkthrough, or an announcement. The API renders a lip-synced, voiced video you can preview, download, and reuse anywhere.
Create a recording
curl -X POST https://companion-api.napster.com/public/companions/{companionId}/recordings \
-H "X-Api-Key: $NAPSTER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "openAi",
"voiceId": "alloy",
"text": "Welcome to Acme. Here is everything you need to get started."
}'Recordings are generated asynchronously. The response returns a recording ID and a status of pending.
Check status and download
# Check status
curl https://companion-api.napster.com/public/companions/{companionId}/recordings/{recordingId} \
-H "X-Api-Key: $NAPSTER_API_KEY"
# Once status is "completed", get the download URL
curl https://companion-api.napster.com/public/companions/{companionId}/recordings/{recordingId}/download-url \
-H "X-Api-Key: $NAPSTER_API_KEY"The download URL is time-limited — retrieve it when you are ready to download. Poll the recording status until it reads completed before requesting the URL.
Manage recordings
GET /public/companions/{companionId}/recordings— list all recordings for a companion.GET /public/companions/{companionId}/recordings/{recordingId}— get status and details.GET /public/companions/{companionId}/recordings/{recordingId}/download-url— get a time-limited download URL once completed.DELETE /public/companions/{companionId}/recordings/{recordingId}— remove a recording.
Common use cases
- Video greetings for landing pages or email campaigns.
- Onboarding walkthrough videos embedded in your product.
- Training clips and announcements reused across multiple channels.
- Pre-produced content for events or kiosk displays.
Note: Generation can take several minutes depending on the length of the text. Plan ahead and generate recordings before they are needed, not at the moment of use.