Get started

Create an API key

An API key lets your own code — a CRM, a script, an automation tool — talk to Daffy Voice on your company's behalf.

Create a key

Open API Keys
In the dashboard go to System Settings → API Keys. Only the company owner or an admin can see this page.
Choose a name and access level
Press Create key, give it a name you'll recognise (for example “CRM sync”) and pick:
- Full access — can read and change everything.
- Read-only — can only read data. Any request that changes something is refused.
Copy it now
The full key is shown once. Copy it and store it somewhere safe, such as your server's environment variables. Afterwards Daffy Voice only shows its first characters.

Use the key

Send it in the Authorization header as a bearer token (an X-API-Key header also works). Keys start with vk_live_ (full access) or vk_test_ (read-only). This call checks that a key works:

Check your key

curl https://calling.ubiqproject.com/api/v1/whoami \
  -H "Authorization: Bearer vk_live_xxxx_your_key"

Response

{
  "tenant_id": "6f1c…",
  "auth_method": "api_key",
  "scope": "full"
}

Revoke a key

On API Keys, press Revoke next to the key. Any code using it stops working immediately. The page also shows when each key was last used, which helps you spot keys nobody needs any more.

Treat keys like passwords

Never put a key in a website, mobile app or shared document. Anyone with a full-access key can change your AI employees and phone numbers.

Next: see the API Reference.