Documentation menu
Reference
API reference
Every resource below is what the dashboard itself calls — there is no separate, more limited public API.
Authentication
Generate a personal API key from Settings → API Keys — shown once, as vc_...; only its hash is stored, so save it somewhere before navigating away. Send it on every request as x-api-key:
curl https://api.voicelo.ai/api/agents \
-H "x-api-key: vc_your_key_here"Generating a new key immediately invalidates the previous one — there is exactly one live key per account.
Base URL and responses
Every route is under /api on your Voicelo instance. A successful response is { status: "success", data: {...} }; an error is a 4xx or 5xx with:
{
"status": "error",
"message": "Agent not found."
}Agents
List every agent on the account.
Fetch one agent. Tool header secrets come back redacted.
Create an agent — see Agents for the field list.
Update any field, including tools, voice engine or knowledge base.
Delete an agent.
The ElevenLabs voices usable on this account.
The live OpenRouter model catalogue.
Which one-click tools this account can add, and which still need connecting.
Leads
List leads, newest first.
Create one — name, phone, optional fields (custom key/value pairs) and tags. A second lead with the same phone number is refused (409), the existing one is returned instead.
Create many at once, e.g. from a parsed CSV.
Update a lead.
Add or remove tags across many leads at once.
Delete many by id.
Every custom field name in use, and how many leads carry it.
Campaigns
List campaigns.
Fetch one, with its progress.
Create one — an agent plus a list of lead ids.
Edit a campaign that hasn’t finished running.
Begin dialling — body { id }.
Pause it — body { id }. Unreached leads stay untouched.
Copy a campaign’s configuration into a new one.
Delete a campaign.
Calls
Place a single call outside any campaign — { to, agentId, name?, fromNumberId?, tags? }. Creates the lead if that phone number isn’t on your list yet.
Call logs
List calls — filterable by status, direction, agent and date range.
Fetch one call’s full transcript.
Stream the recording (range requests supported).
Set the outcome — see Calls & recordings.
Run (or re-run) AI scoring and summary on demand.
Knowledge base
List knowledge bases.
Fetch one.
Create one — { name, basicInfo?, faqs?, otherInfo? }. Rebuilds its search index immediately.
Update any field — the search index is rebuilt from the result.
Delete it and unassign it from every agent that had it.
Draft basic info, FAQs and other info from a public URL, for review before saving.
Appointments
List appointments.
Create one directly from the dashboard or your own backend — an agent uses its own internal booking capability instead. See Agents.
Reschedule or edit one.
Cancel one.
Evals
List evals.
Create one — { name, description?, messages }. See Evals for the turn shape.
Fetch one.
Replace its script.
Delete it and its run history.
Run it against an agent — { agentId }. Runs synchronously and returns the graded result.
Run history for one eval, newest first.
Phone numbers
List numbers on the account.
Search Twilio’s available numbers to buy.
Buy a number and attach it to the account.
Register a number you already own elsewhere (e.g. a SIP DID).
Reassign which agent a number routes inbound calls to.
Release a number.