Authentication

Note

Using the Ultravox API requires an API key. You can apply for a key here.

Base URL

The Ultravox API is available at https://api.ultravox.ai/api/.

X-API-Key Header

When making API calls, pass your key in using the X-API-Key header.

Note

You should never expose your API key to client code.

If you really want to ignore this advice for a local demo, use the X-Unsafe-API-Key header instead at your own risk. It works the same way except that our server will allow it in CORS preflight requests.

Here’s an example showing how to use the fictional API key aBCDef.123456 to get a list of calls.

cURL

curl --request GET \
--url https://api.ultravox.ai/api/calls \
--header 'X-API-Key: aBCDef.123456'

JavaScript

fetch('https://api.ultravox.ai/api/calls', {
  method: 'GET',
  headers: {
    'X-API-Key': 'aBCDef.123456'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));