# Bolna Docs: API Reference > Quickly build and deploy conversational Voice AI agents ## API Reference ### Get started - [Bolna API documentation](https://www.bolna.ai/docs/api-reference/introduction.md): Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows. - [API authentication](https://www.bolna.ai/docs/api-reference/authentication.md): Authenticate Bolna API requests with a Bearer API key in the Authorization header, and generate your API key from the Bolna dashboard. - [Pagination for Bolna APIs](https://www.bolna.ai/docs/api-reference/pagination.md): Learn how to use pagination in Bolna Voice AI APIs using `page_number` and `page_size` to fetch results efficiently and build scalable workflows. - [Rate limiting for Bolna APIs](https://www.bolna.ai/docs/api-reference/rate-limiting.md): Rate limits for Bolna API endpoints, applied per organization or per user, including endpoint-specific limits such as 500 requests a minute. - [Errors & status codes](https://www.bolna.ai/docs/api-reference/errors.md): HTTP status codes, error response shapes, execution status enums and batch status enums returned by the Bolna API, and when you see each one. - [Limits & quotas](https://www.bolna.ai/docs/api-reference/limits.md): Reference for concurrency, rate limits, batch and CSV size caps, webhook delivery, and wallet requirements that apply across the Bolna API. ### Voice agents #### Agents - [Bolna voice AI agent APIs overview](https://www.bolna.ai/docs/api-reference/agent/v2/overview.md): Explore Bolna Voice AI Agent APIs overview, featuring endpoints for creating, managing, and executing autonomous voice agents. - [Retrieve voice AI agent details API](https://www.bolna.ai/docs/api-reference/agent/v2/get.md): Retrieve a Bolna voice AI agent's details with the v2 API, including its configuration, status and tasks, using the agent ID. - [Create voice AI agent API](https://www.bolna.ai/docs/api-reference/agent/v2/create.md): Learn how to create new agents with Bolna APIs, enabling customized tasks, prompts, and configurations for Bolna voice AI agents. - [Update voice AI agent API](https://www.bolna.ai/docs/api-reference/agent/v2/update.md): Update agent configurations, tasks, and prompts to refine behavior and capabilities using Bolna Voice AI agent APIs. - [Patch update to voice AI agent API](https://www.bolna.ai/docs/api-reference/agent/v2/patch_update.md): Partially update a Bolna voice AI agent: name, welcome message, webhook URL, voice, calling guardrails, telephony provider and prompts. - [Read and update an agent rich text prompt via API](https://www.bolna.ai/docs/api-reference/agent/v2/rich-text-prompts.md): Read an agent rich text prompt from composition_by_language in GET /v2/agent, edit its text, variable, tool and language_value nodes, and save with PUT. - [List all voice AI agents API](https://www.bolna.ai/docs/api-reference/agent/v2/get_all.md): List all Voice AI agents under your account, along with their names, statuses, and creation dates, using Bolna APIs. - [Retrieve voice AI agent execution API](https://www.bolna.ai/docs/api-reference/agent/v2/get_agent_execution.md): Fetch specific execution details of a Voice AI agent, including conversation times, statuses, and metrics, via Bolna APIs. - [Delete voice AI agent API](https://www.bolna.ai/docs/api-reference/agent/v2/delete.md): Use Bolna APIs to delete agents and their related data, ensuring proper cleanup of batches, executions, and configurations. - [Stop agent queued calls API](https://www.bolna.ai/docs/api-reference/agent/v2/stop.md): Use Bolna APIs to stop all queued calls for a specific agent, preventing any pending calls from being executed. #### Calls - [Calling APIs overview](https://www.bolna.ai/docs/api-reference/calls/overview.md): Explore Bolna Calling APIs to invoke outbound Voice AI phone calls from your agents. This overview provides the available endpoints and their functionalities. - [Make voice AI call API](https://www.bolna.ai/docs/api-reference/calls/make.md): Learn how to initiate outbound phone calls using Bolna Voice AI agents. Start making phone calls using the agent ID and recipient's phone number. - [Stop a previously initiated voice AI call API](https://www.bolna.ai/docs/api-reference/calls/stop_call.md): Learn how to stop a call when its status is `queued` or `scheduled` This API allows you to cancel pending calls before they are executed. #### Executions - [Executions APIs overview](https://www.bolna.ai/docs/api-reference/executions/overview.md): Access your Voice AI agents call and conversation history using Bolna Executions APIs. This page details the available endpoints for managing call executions. - [Retrieve voice AI execution API](https://www.bolna.ai/docs/api-reference/executions/get_execution.md): Fetch details of a specific phone call execution by its ID using Bolna APIs. This includes information such as conversation time, status, and telephony data. - [Retrieve voice AI execution raw logs API](https://www.bolna.ai/docs/api-reference/executions/get_execution_raw_logs.md): Fetch raw logs of a phone call execution by ID via the Bolna API, including prompts, requests, responses, and optional LLM reasoning summaries. - [Get batch executions API](https://www.bolna.ai/docs/api-reference/executions/get_batch_executions.md): Retrieve all executions for specific batches using Bolna APIs. This endpoint provides detailed information on each call's outcome and metrics within the batch. - [Get all voice AI agent executions API](https://www.bolna.ai/docs/api-reference/executions/get_executions.md): Retrieve all executions performed by a specific agent using Bolna APIs. This endpoint provides a comprehensive history of the agent's calls and conversations. #### Batches - [Batch APIs overview](https://www.bolna.ai/docs/api-reference/batches/overview.md): Create, schedule, stop and track batches of Bolna voice AI calls with the Batch APIs, or upload a CSV under Deploy → Batches in the dashboard. - [Create batch API](https://www.bolna.ai/docs/api-reference/batches/create.md): Discover how to create a batch for Bolna Voice AI agent by uploading a CSV file containing user contact numbers and prompt variable details for users. - [Schedule batch API](https://www.bolna.ai/docs/api-reference/batches/schedule.md): Learn how to schedule a batch for calling via Bolna Voice AI agent by specifying the batch ID and the desired execution time. - [Get batch API](https://www.bolna.ai/docs/api-reference/batches/get_batch.md): Find out how to retrieve details of a specific batch, including its creation time, status, call status and scheduled execution time. - [List all batches API](https://www.bolna.ai/docs/api-reference/batches/get_batches.md): Explore how to list all batches associated with a particular Bolna Voice AI agent, providing an overview of their statuses, schedules and other relevant details - [List batch executions API](https://www.bolna.ai/docs/api-reference/batches/executions.md): Learn how to retrieve all executions from a batch, providing detailed information on each call's outcome and metrics. - [List batch executions API (v2)](https://www.bolna.ai/docs/api-reference/batches/executions_v2.md): Retrieve executions from a batch with pagination support, providing detailed information on each call's outcome and metrics. - [Stop batch API](https://www.bolna.ai/docs/api-reference/batches/stop.md): Stop a running Bolna batch by its batch ID with the Stop batch API, halting the ongoing calls in that batch calling campaign. - [Delete batch API](https://www.bolna.ai/docs/api-reference/batches/delete.md): Understand how to delete a specific batch using its ID, effectively removing it from your scheduled or active batches. #### Knowledge bases - [Knowledgebases overview](https://www.bolna.ai/docs/api-reference/knowledgebase/overview.md): Learn how to ingest PDFs and URLs as knowledgebases for your Bolna Voice AI agents. Agents can use multiple knowledgebases simultaneously. - [Create knowledgebase API](https://www.bolna.ai/docs/api-reference/knowledgebase/create.md): Upload a PDF document or provide a URL to create a knowledgebase, enhancing your Bolna Voice AI agent's information base and response accuracy. - [Get knowledgebase API](https://www.bolna.ai/docs/api-reference/knowledgebase/get_knowledgebase.md): Retrieve details of a specific knowledgebase, including its ID, file name, creation time, and status, using Bolna APIs. - [List all knowledgebases API](https://www.bolna.ai/docs/api-reference/knowledgebase/get_knowledgebases.md): Retrieve all knowledgebases in your Bolna account with the List all knowledgebases API, including each one's status and creation date. - [Delete knowledgebase API](https://www.bolna.ai/docs/api-reference/knowledgebase/delete.md): Remove and delete an existing knowledgebase from your Bolna account maintaining your Bolna Voice AI agents up to date. #### Voices - [Voice APIs overview](https://www.bolna.ai/docs/api-reference/voice/overview.md): Reference for the Voice API group: discover TTS providers and models by language, then fetch the paginated voice list for a chosen provider and model. - [List TTS providers and models](https://www.bolna.ai/docs/api-reference/voice/get_providers.md): Get all supported TTS providers and their models for a given language. Returns provider IDs and model IDs needed to fetch voices. - [List voices](https://www.bolna.ai/docs/api-reference/voice/get_all.md): Get a paginated list of voices for a specific TTS provider and model. Requires provider_id and model_id from the List Providers endpoint. #### Dispositions - [Dispositions API overview](https://www.bolna.ai/docs/api-reference/dispositions/overview.md): Create and manage dispositions, the questions an LLM answers from each call transcript that power Bolna Extractions, grouped into categories. - [List dispositions API](https://www.bolna.ai/docs/api-reference/dispositions/list.md): Retrieve all dispositions accessible to your account via GET /dispositions/, optionally scoped to a specific agent with a query parameter. - [Get disposition API](https://www.bolna.ai/docs/api-reference/dispositions/get.md): Retrieve a single disposition by ID via GET /dispositions/{disposition_id}, optionally scoped to a specific agent for ownership checks. - [Create disposition API](https://www.bolna.ai/docs/api-reference/dispositions/create.md): Create a new disposition and link it to an agent in one POST /dispositions/ request; `agent_id` is required and at least one option type must be set. - [Bulk create dispositions API](https://www.bolna.ai/docs/api-reference/dispositions/bulk-create.md): Atomically create and link multiple dispositions to an agent in one POST /dispositions/bulk request; either all succeed or none are created. - [Update disposition API](https://www.bolna.ai/docs/api-reference/dispositions/update.md): Update a disposition. When scoped to an agent, shared dispositions are copied before editing to protect other agents. - [Delete disposition API](https://www.bolna.ai/docs/api-reference/dispositions/delete.md): Delete a disposition from your account via DELETE /dispositions/{disposition_id}. Only the owning user or an admin can delete it; the action is permanent. - [Test dispositions API](https://www.bolna.ai/docs/api-reference/dispositions/test.md): Run every disposition linked to an agent against a sample transcript via POST to preview grouped extraction results before making live calls. #### Extraction categories - [Extraction categories API overview](https://www.bolna.ai/docs/api-reference/extraction-categories/overview.md): Create and manage extraction categories — named sets of dispositions evaluated together in a single LLM pass after every call. - [List extraction categories API](https://www.bolna.ai/docs/api-reference/extraction-categories/list.md): Retrieve all extraction categories attached to an agent via GET /agent/{agent_id}/extraction-categories, each with the dispositions it owns. - [Create extraction category API](https://www.bolna.ai/docs/api-reference/extraction-categories/create.md): Create an extraction category and attach it to an agent via POST /agent/{agent_id}/extraction-categories; the category owns the model used for its LLM pass. - [Update extraction category API](https://www.bolna.ai/docs/api-reference/extraction-categories/update.md): Rename an extraction category or change its model via PATCH /extraction-categories/{category_id}; renames update the category label on its dispositions. - [Delete extraction category API](https://www.bolna.ai/docs/api-reference/extraction-categories/delete.md): Delete an extraction category and all of its dispositions via DELETE /extraction-categories/{category_id}. Deletion is permanent. ### Telephony #### Phone numbers - [Phone numbers APIs overview](https://www.bolna.ai/docs/api-reference/phone-numbers/overview.md): Manage your phone numbers effectively using Bolna APIs, including buying, listing, deleting and associating numbers with Bolna Voice AI agents. - [Search phone numbers API ](https://www.bolna.ai/docs/api-reference/phone-numbers/search.md): Search available phone numbers by region, locality, or pattern, with price to use them with Bolna Voice agents. - [Buy phone numbers API ](https://www.bolna.ai/docs/api-reference/phone-numbers/buy.md): Buy virtual phone numbers with full purchase, pricing, and provider details to use with Bolna Voice agents for outbound and inbound calls. - [List phone numbers API ](https://www.bolna.ai/docs/api-reference/phone-numbers/get_all.md): Retrieve all phone numbers associated with your account, including details like creation date and telephony provider like Twilio, Plivo, etc. - [Move phone number API](https://www.bolna.ai/docs/api-reference/phone-numbers/move.md): Move a phone number between the main account and sub-accounts in your Bolna organization. An enterprise feature that needs sub-accounts. - [Delete phone numbers API ](https://www.bolna.ai/docs/api-reference/phone-numbers/delete.md): Delete a purchased phone number from your Bolna account to stop billing for it and remove it permanently from your active inventory. #### Compliance - [Compliance APIs overview](https://www.bolna.ai/docs/api-reference/compliance/overview.md): Submit, list, retrieve and delete phone number compliance applications for India (DLT) using the Bolna Compliance APIs. - [List compliance applications API](https://www.bolna.ai/docs/api-reference/compliance/list.md): Retrieve all phone number compliance applications submitted by your account, along with their review status and rejection reason. - [Create compliance application API](https://www.bolna.ai/docs/api-reference/compliance/create.md): Submit a phone number compliance application for India (DLT) with your business details, CIN certificate and GST certificate. - [Get compliance application API](https://www.bolna.ai/docs/api-reference/compliance/get.md): Retrieve a single phone number compliance application by its ID, including its review status and rejection reason. - [Delete compliance application API](https://www.bolna.ai/docs/api-reference/compliance/delete.md): Delete a phone number compliance application and its uploaded documents. Use this to resubmit an application with corrected details. #### Inbound - [Inbound Bolna voice AI agent APIs overview](https://www.bolna.ai/docs/api-reference/inbound/overview.md): Discover how to set up Bolna Voice AI agents to answer inbound calls, enabling responsive communication channels. - [Set inbound agent API](https://www.bolna.ai/docs/api-reference/inbound/agent.md): Configure Bolna Voice AI agent to handle inbound calls automatically by associating it with a specific phone number using Bolna APIs. - [Remove inbound agent API](https://www.bolna.ai/docs/api-reference/inbound/unlink.md): Remove and unlink a Bolna Voice AI agent from a specific phone number to disable automated inbound voice call answering by AI agents. #### SIP trunks - [SIP trunks API overview](https://www.bolna.ai/docs/api-reference/trunks/overview.md): Connect your own SIP carrier to Bolna with the /trunk API: trunks, gateways for outbound calls, carrier IPs for inbound calls, and numbers mapped to agents. - [List SIP trunks API](https://www.bolna.ai/docs/api-reference/trunks/list.md): List your SIP trunks via GET /trunk/trunks, each with its gateways, carrier IPs, numbers, health and active calls. - [Create SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/create.md): Create a SIP trunk to your own carrier via POST /trunk/trunks, with gateways for outbound calls and carrier IPs for inbound calls. - [Get SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/get.md): Retrieve one SIP trunk via GET /trunk/trunks/{trunk_id}, with its gateways, carrier IPs, numbers, health and active calls. - [Update SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/update.md): Change a SIP trunk's settings via PATCH /trunk/trunks/{trunk_id}. Only fields you send change; gateways, carrier IPs and numbers have their own endpoints. - [Delete SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/delete.md): Delete a SIP trunk with its gateways, carrier IPs and numbers via DELETE /trunk/trunks/{trunk_id}; inbound and outbound calls on it stop. - [Add gateway to SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/add_gateway.md): Add a carrier SIP host that outbound calls are sent to via POST /trunk/trunks/{trunk_id}/gateways; gateways are tried in priority order. - [Remove gateway from SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/remove_gateway.md): Remove a gateway from a SIP trunk via DELETE /trunk/trunks/{trunk_id}/gateways/{gateway_id}; outbound calls stop using it. - [Add carrier IP to SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/add_carrier_ip.md): Allow inbound calls from your carrier by adding its signalling address or CIDR range via POST /trunk/trunks/{trunk_id}/ip-acls. - [Remove carrier IP from SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/remove_carrier_ip.md): Stop accepting inbound calls from a carrier address on a SIP trunk via DELETE /trunk/trunks/{trunk_id}/ip-acls/{acl_id}. - [Add number to SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/add_number.md): Add a phone number from your carrier to a SIP trunk via POST /trunk/trunks/{trunk_id}/numbers, optionally with the agent that answers it. - [Remove number from SIP trunk API](https://www.bolna.ai/docs/api-reference/trunks/remove_number.md): Remove a phone number from a SIP trunk via DELETE /trunk/trunks/{trunk_id}/numbers/{number_id}; inbound calls to it are refused. - [Assign agent to SIP trunk number API](https://www.bolna.ai/docs/api-reference/trunks/assign_agent.md): Set or clear the agent that answers inbound calls to a SIP trunk number via PATCH /trunk/numbers/{number_id}, with the trunk default as fallback. - [List SIP trunk calls API](https://www.bolna.ai/docs/api-reference/trunks/list_calls.md): List recent inbound and outbound calls on a SIP trunk's numbers via GET /trunk/trunks/{trunk_id}/calls, with outcome and SIP code. - [Get SIP trunk connection details API](https://www.bolna.ai/docs/api-reference/trunks/connection_details.md): Get Bolna's SIP edge values to configure at your carrier via GET /trunk/pop: SIP domain, port, transports, signalling IPs and RTP port range. #### SIP trunks (legacy) - [SIP trunk API reference](https://www.bolna.ai/docs/api-reference/sip-trunks/overview.md): API endpoints for managing SIP trunks, gateways, and phone numbers on Bolna. Create, update, list, and delete trunks programmatically. - [Create SIP trunk](https://www.bolna.ai/docs/api-reference/sip-trunks/create.md): Create a new SIP trunk on Bolna and register it with your gateway details. Set up your trunk for inbound and outbound voice calling. - [List SIP trunks](https://www.bolna.ai/docs/api-reference/sip-trunks/get_all.md): List all SIP trunks configured in your Bolna account. Filter by active status and view trunk details including gateways and phone numbers. - [Get SIP trunk](https://www.bolna.ai/docs/api-reference/sip-trunks/get.md): Get a single SIP trunk with full details including gateways, IP identifiers, and phone numbers. Look up any trunk by its ID. - [Update SIP trunk](https://www.bolna.ai/docs/api-reference/sip-trunks/update.md): Partially update an existing SIP trunk on Bolna using a PATCH request. Only the fields you include in the request body will be changed. - [Delete SIP trunk](https://www.bolna.ai/docs/api-reference/sip-trunks/delete.md): Permanently delete a SIP trunk and all associated resources including gateways, IP identifiers, and phone numbers. - [Add phone number to trunk](https://www.bolna.ai/docs/api-reference/sip-trunks/add_number.md): Add a DID phone number to your SIP trunk using the Bolna API. Assign numbers for inbound and outbound voice calling on your trunk. - [List phone numbers on trunk](https://www.bolna.ai/docs/api-reference/sip-trunks/list_numbers.md): List all phone numbers associated with a SIP trunk. View assigned DID numbers and manage your trunk number inventory. - [Remove phone number from trunk](https://www.bolna.ai/docs/api-reference/sip-trunks/remove_number.md): Remove a phone number from a legacy SIP trunk. If the number was mapped to an agent, that mapping is removed too. New setups use the SIP trunks API. #### Violations - [Violations APIs overview](https://www.bolna.ai/docs/api-reference/violations/overview.md): Manage and track call violations using the Bolna Violations APIs. List violations with filtering and pagination, and submit violation evidence. - [List violations API](https://www.bolna.ai/docs/api-reference/violations/list.md): Retrieve a paginated list of violations, optionally filtered by status. Use this endpoint to monitor and manage call violations across your account. - [Submit violation API](https://www.bolna.ai/docs/api-reference/violations/submit.md): Submit a violation along with an evidence file (e.g., a screenshot or document). This endpoint updates the violation status and attaches the uploaded file. ### Workflows #### Workflows - [Workflow APIs overview](https://www.bolna.ai/docs/api-reference/workflows/overview.md): Build multi-step outreach sequences combining voice calls, WhatsApp messages, API calls, waits, and retries, then run them over one contact or thousands. - [Create workflow API](https://www.bolna.ai/docs/api-reference/workflows/create.md): Create a new workflow via POST /workflows, starting an empty draft at revision 0 ready to receive a saved, validated, and published definition. - [List workflows API](https://www.bolna.ai/docs/api-reference/workflows/list.md): List your workflows via GET /workflows, newest first, with optional case-insensitive filtering by a substring of the workflow name. - [Get workflow API](https://www.bolna.ai/docs/api-reference/workflows/get.md): Retrieve a workflow with its draft metadata and every published version, including per-version campaign and outcome totals. - [Update workflow API](https://www.bolna.ai/docs/api-reference/workflows/update.md): Rename a workflow or update its settings, such as the execution webhook. Settings are merged, so each change is applied on its own. - [Delete workflow API](https://www.bolna.ai/docs/api-reference/workflows/delete.md): Soft-delete a workflow via DELETE /workflows/{workflow_id}; existing campaigns and past executions are preserved for reporting purposes. - [Get workflow draft API](https://www.bolna.ai/docs/api-reference/workflows/get-draft.md): Read a workflow's stored draft definition and its current revision, the compare-and-set token you pass back when saving the draft. - [Save workflow draft API](https://www.bolna.ai/docs/api-reference/workflows/save-draft.md): Save the draft definition using an optimistic-concurrency revision token, so concurrent editors never silently overwrite each other. - [Validate workflow API](https://www.bolna.ai/docs/api-reference/workflows/validate.md): Check the saved draft against every graph and node rule without mutating anything. Errors block publish; warnings do not. - [Publish workflow API](https://www.bolna.ai/docs/api-reference/workflows/publish.md): Validate the current draft and freeze it via POST as an immutable published version that campaigns and run requests execute against. - [Get workflow version API](https://www.bolna.ai/docs/api-reference/workflows/get-version.md): Retrieve the frozen definition of one published workflow version via GET, identified by workflow ID and version number, for auditing or replay. - [Run workflow API](https://www.bolna.ai/docs/api-reference/workflows/run.md): Run a single contact through the latest published version of a workflow via POST, returning an execution ID you can poll for status and results. - [Test workflow webhook API](https://www.bolna.ai/docs/api-reference/workflow-webhooks/test.md): Send one sample execution webhook to the workflow's configured destination and see exactly what your server did with it. - [Get callback URL API](https://www.bolna.ai/docs/api-reference/workflows/get-callback.md): Fetch a workflow callback node's inbound URL and signing secret, so your system knows where to POST results and how to sign them. - [Rotate callback URL API](https://www.bolna.ai/docs/api-reference/workflows/rotate-callback.md): Replace a callback node's inbound URL and signing secret. Executions already waiting are reached through the new URL. - [Get last callback API](https://www.bolna.ai/docs/api-reference/workflows/get-last-callback.md): See the last request a callback node's URL received in the past 30 minutes, how it was correlated, and whether an execution took it. - [Workflow node types API](https://www.bolna.ai/docs/api-reference/workflows/node-types.md): Discover every node type with its configuration parameters, defaults and bounds, plus the variable namespaces available to conditions. #### Campaigns - [Workflow campaign APIs overview](https://www.bolna.ai/docs/api-reference/workflow-campaigns/overview.md): Run a published workflow over a batch of contacts: upload entries as CSV or JSON, start the campaign, and track progress with per-node reports. - [Create workflow campaign API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/create.md): Create a campaign that pins one published version of a workflow. Pass version null to pin the latest published version. - [List workflow campaigns API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/list.md): List Bolna workflow campaigns filtered by workflow, status or kind, and sorted by creation time, name or outcome counts. - [Get workflow campaign API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/get.md): Retrieve a Bolna workflow campaign with a per-status count of its entries and per-code counts of any upload validation failures. - [Upload campaign entries API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/upload-entries.md): Bulk-upload contacts as CSV rows or a JSON array. Rows are validated individually, with per-row failures reported alongside the accepted count. - [List campaign entries API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/list-entries.md): List a workflow campaign's entries, including rows that failed upload validation together with the failure code for each one. - [Campaign entries template API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/entries-template.md): Download the one-line CSV header naming exactly the columns required for a workflow campaign entry upload, fetched via GET with the campaign ID. - [Start workflow campaign API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/start.md): Start dialing a campaign's pending entries. Requires at least one pending entry; repeating the call is a no-op. - [Pause workflow campaign API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/pause.md): Pause a running campaign. No new work starts; executions waiting on timers hold at their next dispatch until you resume. - [Resume workflow campaign API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/resume.md): Resume a paused workflow campaign via POST; held executions continue from the step where they paused rather than restarting from the beginning. - [Abort workflow campaign API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/abort.md): Abort a campaign. Terminal: every execution stops before its next external action and the campaign cannot be resumed. - [List campaign executions API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/list-executions.md): List a campaign's executions, filterable by status and outcome. Poll after starting to watch contacts progress. - [Workflow campaign report API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/report.md): Aggregated campaign report: execution counts by status, termination reasons, and a per-node funnel keyed by your definition's node ids. - [Delete workflow campaign API](https://www.bolna.ai/docs/api-reference/workflow-campaigns/delete.md): Delete a workflow campaign via DELETE; only allowed while the campaign is still a draft with no uploaded entries and no executions. #### Executions - [Workflow execution APIs overview](https://www.bolna.ai/docs/api-reference/workflow-executions/overview.md): Track and control individual contacts moving through a workflow: node-by-node history, timeline events, and cancellation. - [Get workflow execution API](https://www.bolna.ai/docs/api-reference/workflow-executions/get.md): The whole story of one contact's run: current status, every node attempt with the edge it took, and the recent timeline. Poll until terminal. - [Cancel workflow execution API](https://www.bolna.ai/docs/api-reference/workflow-executions/cancel.md): Stop one contact's execution before its next external action. Canceling an already-terminal execution is a no-op. - [Resend execution webhook API](https://www.bolna.ai/docs/api-reference/workflow-webhooks/resend.md): Send a finished execution's webhook again, to the workflow's current webhook URL, with the payload it originally carried. ### Account #### User - [User APIs overview](https://www.bolna.ai/docs/api-reference/user/overview.md): Explore APIs related to user and account information for Bolna Voice AI agents, including endpoints for adding custom LLM models and custom TTS voices. - [User information](https://www.bolna.ai/docs/api-reference/user/info.md): Get details like name, email, current wallet balance, concurrency limits, and account status for the authenticated user via GET /user/me. - [Add a new custom LLM model](https://www.bolna.ai/docs/api-reference/user/add_model.md): Add your own custom Large Language Model to Bolna via API and select it as the LLM for your Bolna voice AI agents. - [List your custom LLM models](https://www.bolna.ai/docs/api-reference/user/list_custom_models.md): List the custom LLMs in your account or sub-account, each with the ID needed to delete it. Sub-accounts also see the account's models. - [Delete a custom LLM model](https://www.bolna.ai/docs/api-reference/user/delete_model.md): Delete a custom LLM and its stored endpoint key from your Bolna account. A model still selected on an agent cannot be deleted. - [Add a custom TTS voice](https://www.bolna.ai/docs/api-reference/user/add_custom_tts.md): Register a voice from your own OpenAI-compatible text-to-speech server so Bolna voice agents can speak with it. - [List your custom TTS voices](https://www.bolna.ai/docs/api-reference/user/list_custom_tts.md): List the custom text-to-speech voices in your account or sub-account, each with its ID. Sub-accounts also see the account's voices. - [Delete a custom TTS voice](https://www.bolna.ai/docs/api-reference/user/delete_custom_tts.md): Delete a custom text-to-speech voice and its stored endpoint key from Bolna. A voice still selected on an agent cannot be deleted. #### Providers - [Providers APIs overview](https://www.bolna.ai/docs/api-reference/providers/overview.md): Add and manage your own providers in Bolna via API, the same telephony and voice providers you connect under Settings → Integrations. - [Add a new provider API](https://www.bolna.ai/docs/api-reference/providers/add.md): Learn how to securely add a new provider to your Bolna account by specifying the provider's name and associated credentials. - [List providers API ](https://www.bolna.ai/docs/api-reference/providers/get.md): Retrieve all providers associated with your Bolna account, including their IDs, names, and creation timestamps. - [Remove a provider API](https://www.bolna.ai/docs/api-reference/providers/remove.md): Delete a previously added provider from your Bolna account with the Remove provider API, keeping your connected integrations current. #### Sub-accounts - [Sub accounts APIs overview](https://www.bolna.ai/docs/api-reference/sub-accounts/overview.md): Manage multiple customers or business units with Bolna Sub-Accounts API. Create, list, and track usage with clear data separation and control. - [Create a new sub-account API](https://www.bolna.ai/docs/api-reference/sub-accounts/create.md): Create a new sub-account using the Bolna API to define separate workspaces with custom configurations for enterprise-level management. - [List all sub-accounts API](https://www.bolna.ai/docs/api-reference/sub-accounts/get_all.md): Retrieve all sub-accounts linked to your main Bolna account for centralized visibility and management. An enterprise feature. - [Patch update a sub-account](https://www.bolna.ai/docs/api-reference/sub-accounts/patch_update.md): Use this Bolna API endpoint to partially modify and update sub-account properties, including its name and concurrency limits. - [Track sub-account usage API](https://www.bolna.ai/docs/api-reference/sub-accounts/usage.md): Track usage for one Bolna sub-account, with fine-grained insight into its usage, consumption and billing. An enterprise feature. - [Get all sub-accounts usage API](https://www.bolna.ai/docs/api-reference/sub-accounts/all_usage.md): Retrieve aggregated usage, consumption and cost breakdowns for every sub-account in your organization. An enterprise feature of Bolna. - [Deleting a sub-account](https://www.bolna.ai/docs/api-reference/sub-accounts/delete.md): Use Bolna APIs to delete a sub-account and their related data, ensuring proper cleanup of agents, batches, executions, and configurations. ### Legacy #### Agent v1 - [Bolna voice AI agent APIs overview (deprecated)](https://www.bolna.ai/docs/api-reference/agent/overview.md): Deprecated v1 agent APIs and the agent object attributes. Use the v2 agent APIs to create, read, update and list Bolna voice AI agents. - [Create voice AI agent API (deprecated)](https://www.bolna.ai/docs/api-reference/agent/create.md): Deprecated v1 endpoint to create a Bolna voice AI agent. New integrations should use the v2 Create agent API, which replaces this endpoint. - [Retrieve voice AI agent details API (deprecated)](https://www.bolna.ai/docs/api-reference/agent/get.md): Deprecated v1 endpoint to retrieve a Bolna voice AI agent. New integrations should use the v2 Get agent API, which replaces this endpoint. - [Update voice AI agent API (deprecated)](https://www.bolna.ai/docs/api-reference/agent/update.md): Deprecated v1 endpoint to replace an agent configuration. New integrations should use the v2 Update agent API. - [Patch update to voice AI agent API (deprecated)](https://www.bolna.ai/docs/api-reference/agent/patch_update.md): Deprecated v1 endpoint to partially update an agent. New integrations should use the v2 Patch update agent API. - [List all voice AI agents API (deprecated)](https://www.bolna.ai/docs/api-reference/agent/get_all.md): Deprecated v1 endpoint to list all your Bolna voice AI agents. New integrations should use the v2 List all agents API, which replaces it. - [Get all agent executions API (v1, deprecated)](https://www.bolna.ai/docs/api-reference/agent/get_all_agent_executions.md): Deprecated v1 endpoint to list executions for an agent. New integrations should use the v2 agent executions API.