# Verbeo

- [Verbeo REST API overview](https://docs.verbeo.ai/api-reference/overview.md): A complete reference for the Verbeo Campaigns REST API. Learn the base URL, request and response formats, versioning policy, rate limits, and how to get support.
- [API authentication and keys](https://docs.verbeo.ai/api-reference/authentication.md): Learn about Verbeo's two API key types, which endpoints each one can access, how to generate keys from the dashboard, and how to pass them in requests.
- [Responses](https://docs.verbeo.ai/api-reference/responses.md): Standard success-response envelope, pagination format, and common conventions for every Verbeo API endpoint.
- [Errors](https://docs.verbeo.ai/api-reference/errors.md): How the Verbeo API reports errors — the standard envelope, HTTP status conventions, and the full reference of global and module-specific error codes.
- [Assistants](https://docs.verbeo.ai/api-reference/assistants/overview.md): Create and manage the AI voice agents that answer and place your calls — the assistant object, its configuration document, and how the endpoints fit together.
- [List assistants](https://docs.verbeo.ai/api-reference/assistants/list.md): Page through the assistants in your workspace, most recently edited first, with an optional name search.
- [Create assistant](https://docs.verbeo.ai/api-reference/assistants/create.md): Create an AI voice agent in your workspace. Send as little as a name — the configuration is completed with the same defaults a dashboard-created assistant gets.
- [Get assistant](https://docs.verbeo.ai/api-reference/assistants/get.md): Retrieve one assistant with its complete configuration — prompt, voice, tools, settings and SIP details.
- [Update assistant](https://docs.verbeo.ai/api-reference/assistants/update.md): Change an assistant's name, type or any part of its configuration. Send only what you are changing.
- [Replace assistant](https://docs.verbeo.ai/api-reference/assistants/replace.md): Save an assistant's whole configuration document at once, replacing the stored one.
- [Delete assistant](https://docs.verbeo.ai/api-reference/assistants/delete.md): Permanently delete an assistant. Campaigns that use it are deleted with it, and phone numbers routed to it stop answering.
- [Tools](https://docs.verbeo.ai/api-reference/tools/overview.md): Give an assistant the tools it can use during a live call: your own HTTP endpoints, and Verbeo's built-in end-call, transfer and SMS tools. The tool object, how secrets are handled, and how the endpoints fit together.
- [List tools](https://docs.verbeo.ai/api-reference/tools/list.md): Page through one assistant's tools, custom and native, newest first, with an optional search on the tool name.
- [Get tool](https://docs.verbeo.ai/api-reference/tools/get.md): Retrieve one tool, custom or native, with its secrets masked.
- [Create custom tool](https://docs.verbeo.ai/api-reference/tools/create-custom.md): Add an HTTP endpoint of yours as a tool an assistant can call during a live call. The tool is added to the assistant's toolIds in the same request.
- [Update custom tool](https://docs.verbeo.ai/api-reference/tools/update-custom.md): Change a custom tool's name, endpoint, headers, arguments or timing. Send only the fields you are changing; saved header values are kept when you send them back as the placeholder.
- [Create native tool](https://docs.verbeo.ai/api-reference/tools/create-native.md): Add one of Verbeo's built-in tools to an assistant: end_call to hang up, transfer_call to hand the call to a person, send_sms to text the caller. It is switched on in the assistant's nativeTools in the same request.
- [Update native tool](https://docs.verbeo.ai/api-reference/tools/update-native.md): Change a native tool's settings: its wording, a transfer's destination, an SMS tool's content or Twilio account. Send only the fields you are changing; saved credentials are kept when you send them back as the placeholder.
- [Delete tool](https://docs.verbeo.ai/api-reference/tools/delete.md): Delete a tool of either kind. It is taken out of the assistant's toolIds, and a native tool is switched off in nativeTools, in the same request.
- [Phone numbers](https://docs.verbeo.ai/api-reference/phone-numbers/overview.md): Connect the phone numbers your assistants answer and call from — the phone number object, the two ways to add a number, and how the endpoints fit together.
- [List phone numbers](https://docs.verbeo.ai/api-reference/phone-numbers/list.md): Page through the phone numbers in your workspace, newest first, with an optional search on the number or its nickname.
- [Get phone number](https://docs.verbeo.ai/api-reference/phone-numbers/get.md): Retrieve one phone number, with the assistants it answers and dials with.
- [Connect a SIP-trunk number](https://docs.verbeo.ai/api-reference/phone-numbers/connect-sip.md): Connect a phone number from any carrier over SIP trunking, and choose the assistants that answer it and dial from it.
- [Import a Twilio number](https://docs.verbeo.ai/api-reference/phone-numbers/import-twilio.md): Add a phone number you own in Twilio by its Account SID and Auth Token, and choose the assistants that answer it and dial from it.
- [Configure a Twilio number's webhook](https://docs.verbeo.ai/api-reference/phone-numbers/twilio-webhook.md): Point an imported Twilio number's voice webhook and status callback at Verbeo, inside your own Twilio account.
- [Update phone number](https://docs.verbeo.ai/api-reference/phone-numbers/update.md): Change the assistants a number answers and dials with, its dial rate, or its inbound call webhook. Send only the fields you are changing.
- [Delete phone number](https://docs.verbeo.ai/api-reference/phone-numbers/delete.md): Disconnect a phone number from Verbeo. Its call history and finished campaigns are kept; a campaign that can still dial from it blocks the delete.
- [Create phone call](https://docs.verbeo.ai/api-reference/calls/create.md): Place an outbound phone call with an AI voice agent from one of your phone numbers. Pass dynamic variables to personalize each call.
- [List calls](https://docs.verbeo.ai/api-reference/calls/list-v2.md): Page through your workspace's call history, newest first, filtered by type, assistant, campaign, number, date, duration, cost or how the call ended.
- [Get call](https://docs.verbeo.ai/api-reference/calls/get-v2.md): Read one call in full: transcript, recording, summary, post-call analysis and the dynamic variables it was placed with.
- [Get a call's tool executions](https://docs.verbeo.ai/api-reference/calls/tool-executions.md): Every tool the assistant ran during a call — what it was asked and what came back — in the order it ran.
- [Get call fields in bulk](https://docs.verbeo.ai/api-reference/calls/fields.md): Read the heavy fields — transcripts, summaries, analysis — of up to 100 calls in one request, for an export.
- [Get concurrency](https://docs.verbeo.ai/api-reference/calls/concurrency.md): How many of your workspace's calls are in progress right now, against its concurrent-call limit.
- [Fix transcript](https://docs.verbeo.ai/api-reference/calls/fix-transcript.md): Rebuild a call's transcript from its recording, then send its call_analyzed webhook again with the corrected content.
- [Get a call's webhook deliveries](https://docs.verbeo.ai/api-reference/calls/webhook-logs.md): Every attempt Verbeo made to deliver a call's webhooks: what was sent, where, and what your endpoint answered.
- [Resend webhooks](https://docs.verbeo.ai/api-reference/calls/resend-webhooks.md): Deliver some of a call's webhook events again — the same events, under the same event ids, so your deduplication sees one event.
- [POST /calls — Create a phone call (v1)](https://docs.verbeo.ai/api-reference/calls/initiate.md): Place an outbound phone call with an AI voice agent over your LiveKit SIP number. Pass dynamic variables to personalize each call.
- [Campaigns overview](https://docs.verbeo.ai/api-reference/campaigns/overview.md): REST endpoints for creating, monitoring, and controlling outbound batch campaigns, plus the campaign-specific error codes.
- [List campaigns](https://docs.verbeo.ai/api-reference/campaigns/list.md): Return campaigns owned by your workspace, newest first, with offset-based pagination and an optional status filter.
- [Create campaign](https://docs.verbeo.ai/api-reference/campaigns/create.md): Create an outbound batch campaign with a contact list, retry logic, optional scheduling, and optional business-hours gating. Campaigns start in draft status until you resume them.
- [Get campaign](https://docs.verbeo.ai/api-reference/campaigns/get.md): Return a campaign's current state and aggregate counters.
- [Update campaign](https://docs.verbeo.ai/api-reference/campaigns/update.md): Update a campaign's settings. Only allowed in draft, scheduled, or paused status — pause first, update, then resume.
- [Cancel campaign](https://docs.verbeo.ai/api-reference/campaigns/delete.md): Cancel a campaign. Stops dialing and marks it cancelled. This is the REST equivalent of the dashboard's archive action.
- [Pause campaign](https://docs.verbeo.ai/api-reference/campaigns/pause.md): Pause a running or dormant campaign. Stops new dials; in-flight calls finish naturally.
- [Resume / start campaign](https://docs.verbeo.ai/api-reference/campaigns/resume.md): Start a draft or scheduled campaign, or resume a paused one. The server picks the right action based on the campaign's current status.
- [Campaign stats](https://docs.verbeo.ai/api-reference/campaigns/stats.md): Campaign state plus a per-contact-status breakdown.
- [Webhook events](https://docs.verbeo.ai/api-reference/webhooks/events.md): Reference for the three call lifecycle webhook events: call_started, call_ended, and call_analyzed. Includes exact payload shapes and field-level notes.
- [Tool call webhooks](https://docs.verbeo.ai/api-reference/webhooks/tool-calls.md): Reference for the tool_invoked webhook. Fired during a live call when the agent invokes a custom tool. Includes payload shapes for POST and GET methods.
- [Phone Numbers](https://docs.verbeo.ai/concepts/phone-numbers.md): Connect numbers in the Verbeo dashboard or through the API, assign them to agents for inbound calls, and use them as the caller ID for outbound calls.
- [Import a Phone Number from Twilio](https://docs.verbeo.ai/guides/import-twilio-number.md): Connect a Twilio phone number to Verbeo AI using Twilio Elastic SIP Trunking so your AI agents can take inbound calls and place outbound calls.
- [Personalize inbound calls with a webhook](https://docs.verbeo.ai/guides/inbound-call-webhook.md): Configure an inbound call webhook on a phone number so your backend can supply dynamic variables and choose which agent answers, before the call connects.
- [Agent SIP URI](https://docs.verbeo.ai/features/sip-uri.md): Every Verbeo agent has its own SIP address. Point a softphone, PBX, SIP trunk, or carrier at it to route calls straight to that agent's AI — no phone number or outbound API needed.
- [Add the web widget to your site](https://docs.verbeo.ai/guides/web-widget.md): Embed a voice agent on your website with a copy-paste snippet. Visitors talk to your agent in the browser over WebRTC — no phone number required.
- [How Calls Work in Verbeo](https://docs.verbeo.ai/concepts/calls.md): Understand the full call lifecycle in Verbeo — call types, states, captured data, dynamic variables, and the post-call analysis flow.
- [Extract insights with post-call analysis](https://docs.verbeo.ai/guides/post-call-analysis.md): Define structured extraction fields so Verbeo automatically pulls named data from every call transcript and delivers it to your webhook.
- [Receive real-time call events with webhooks](https://docs.verbeo.ai/guides/webhooks.md): Configure a webhook URL on your agent to receive call_started, call_ended, call_analyzed, and tool_invoked events in real time.
- [Paying with a card issued in India](https://docs.verbeo.ai/guides/paying-from-india.md): How top-ups and auto-reload work when your saved card was issued in India, and what to do when a bank authorisation or a reload fails.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.