Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vocobase.com/llms.txt

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

​
Authentication

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

​
Base URL

All API requests use the following base URL: 
https://api.vocobase.com/api/v2

​
API key format

Vocobase API keys use the prefix rg_live_ followed by a random string: 
rg_live_abc123def456ghi789jkl012
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: 
curl -X GET https://api.vocobase.com/api/v2/config \
  -H "Authorization: Bearer rg_live_abc123def456ghi789jkl012"
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:
Endpoint categoryLimitWindow
General endpoints60 requestsPer minute
Call endpoints (/calls/*)10 requestsPer minute
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: 
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error description"
  }
}

​
Authentication error codes

HTTP StatusCodeDescription
401UNAUTHORIZEDMissing or invalid API key. Verify your Authorization header contains a valid rg_live_ key.
403FORBIDDENYour API key is valid but you do not have permission for this action. Common causes: insufficient balance (₹), suspended account, or partner not yet approved.

​
Other common error codes

HTTP StatusCodeDescription
400VALIDATION_ERRORRequest body is missing required fields or contains invalid values. Check the message field for details.
404NOT_FOUNDThe requested resource does not exist or does not belong to your account.
409CONFLICTA resource with the same unique identifier already exists (e.g., duplicate agent name).
429LIMIT_REACHEDRate limit or concurrency limit exceeded.
500INTERNAL_ERRORAn unexpected server error occurred. Retry the request. If the issue persists, contact support.
502INTERNAL_ERRORA downstream service (e.g., telephony provider) failed. Retry the request.

​
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.