API Reference

The pages under this section document all 166 endpoints on the V2 partner API, generated from openapi.json. Every endpoint takes the same base URL and auth:

https://api.vocobase.com/api/v2
Authorization: Bearer rg_live_...

See Authentication for how to get a key, and Getting API access for account setup.

What lives where

Area	Endpoints
Agents	`/agent/*` — CRUD, voices, tools, documents, dictionaries, extraction sets, inbound face
Calls	`/calls/*` — start, list, recording URLs, transfer, extraction, concurrency
Campaigns	`/campaigns/*` — batch calling, contacts, lifecycle, stats. Guide: Campaigns
Documents	`/documents/*` — upload, web links, paragraphs. Guide: Knowledge base
Dictionaries	`/dictionaries/*`. Guide: Dictionaries
Extraction sets	`/extraction-sets/*`. Guide: Post-call extraction
Functions	`/functions/` and `/agent/{id}/functions/`. Guide: Custom functions
Lifecycle hooks	`/agents/{agentId}/lifecycle-hooks/*`. Guide: Lifecycle hooks
Telephony	`/telephony/`, `/phone-numbers/`, `/config/telephony/`, `/voicelink/`. Guide: Bring your own provider
Inbound routing	`/inbound-route-policies/*`, `/inbound-route-decisions`. Guide: Inbound routing policies
Messaging	`/messaging/*`. Guide: WhatsApp messaging
Customers	`/customers/`, `/connectors/`. Guide: B2B2B customers
Billing	`/billing/*`. Guide: Credits
Config & webhooks	`/config/*`. Guide: Webhook setup
Projects	`/projects/*`. Guide: Projects

Response shape

Almost every endpoint returns an envelope:

{ "success": true, "data": { } }

{ "success": false, "error": { "code": "VALIDATION_ERROR", "message": "…" } }

Two families are the exception and return a bare object with no envelope — lifecycle hooks (/agents/{agentId}/lifecycle-hooks/*) and the integration audit log (/integration-logs). Their errors are bare too, in the form { "error": "…" }. Each affected operation says so on its own page.

Rate limits

The partner API is limited to 60 requests per minute per account. Exceeding it returns 429 with code RATE_LIMIT_EXCEEDED.