Skip to main content

Authentication

All Vocobase API requests are authenticated using API keys passed as Bearer tokens.

Base URL

All API requests use the following base URL:

API key format

Vocobase API keys use the prefix rg_live_ followed by a random string:
You can create API keys from the Vocobase Dashboard under API Keys.
API keys are shown only once at creation time. Store them securely — they cannot be retrieved later.

Including your API key

Pass your API key in the Authorization header as a Bearer token:
Do not include your API key in query parameters or request bodies. Only the Authorization header is supported.

Rate limits

The API enforces rate limits per API key: When you exceed a rate limit, the API returns a 429 Too Many Requests response. Back off and retry after the window resets.

Concurrency limits

Outbound calls have a concurrency limit of 5 simultaneous active calls per partner. If you attempt to start a call while at the limit, you will receive a 429 response.

Error responses

All error responses follow this format:

Authentication error codes

Other common error codes

Security best practices

  • Never expose API keys in client-side code. Always call the Vocobase API from your backend server.
  • Rotate keys periodically. Delete old keys and create new ones from the dashboard.
  • Use separate keys for development and production environments.
  • Monitor usage via the dashboard to detect unauthorized access.