Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

Downloading a recording involves a multi-step process using the Vobiz API. Because recording files are stored securely, every request to access the physical file must be authenticated with your API credentials.

Step-by-step guide to downloading recordings

Follow these three steps to successfully list, retrieve, and download a recording file.

1. List all recordings

First, retrieve a list of available recordings to find the recording_id you need.
List Recordings
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/?limit=20" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json"

2. Retrieve Specific Recording Details

Once you have the ID, fetch its metadata to get the recording_url.
Get Recording Metadata
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/{recording_id}/" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json"

3. Download the physical file

Important: The recording_url requires authentication. You must pass your X-Auth-ID and X-Auth-Token headers in the download request.
Download via cURL
curl -L "https://media.vobiz.ai/v1/Account/{auth_id}/Recording/{recording_id}.wav" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -o my_recording.wav
Note: The -L flag ensures cURL follows any server redirects.

Why Dashboard Playback Fails

Dashboard playback may fail with a 401 Unauthorized error because standard HTML <audio> and <video> tags cannot send custom HTTP headers (like X-Auth-ID).

How to fix this on your platform

1. Server-side proxy

Create an endpoint on your own backend (e.g., /api/play?id=123) that fetches the file from Vobiz using your tokens and streams the binary data back to the dashboard.

2. Pre-download & serve

Use your server logic to download recordings to local storage first, and then serve them as static files directly to your clients.