Bolna Docs

API Reference

Examples & Tutorials

Changelog

Playground

Log In

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.

Create batch

Create Batch API

bearerAuth

Learn how to create conversational voice agents with Bolna AI to qualify leads, boost sales, automate customer support, and streamline recruitment and hiring

Introduction

Bolna AI: Create and deploy Voice Agents

An overview of the various components that make up Bolna Voice AI agents, along with the key tasks these agents are designed to perform.

Platform Concepts

Discover detailed insights into Bolna Voice AI's pricing structure. Learn about cost breakdowns and flexible plans tailored to your business needs.

Pricing

Discover Bolna Enterprise solutions for large-scale businesses, offering scalable Voice AI agents, advanced integrations, and custom seamless solutions.

Bolna Enterprise

Scalable Voice AI Solutions for Large Businesses

Explore practical tips and tricks to enhance the performance of Bolna Voice AI agents. Master best practices for effective implementation.

Prompting guide

Prompting & best practices for Bolna Voice AI agents

Browse Bolna's Voice AI agent templates for quick and efficient setup. Customize pre-built agents to create powerful, AI-driven voice agents seamlessly.

Agent templates

Explore the list of providers supported by Bolna Voice AI, including integrations for telephony, transcription, and text-to-speech services to lower your costs

Connect your Providers

Supported Providers for Bolna Voice AI

Learn how to effectively use context in Bolna Voice AI agents to create dynamic, personalized, and meaningful interactions

Adding variables

Using Context with Bolna Voice AI Agents

Access detailed insights into call logs and data with Bolna Voice AI. Learn how to analyze and utilize call details for better decision-making.

Understanding call details

Understanding Call Details in Bolna Voice AI

Explore function calling capabilities in Bolna Voice AI. Automate complex workflows by integrating custom functions with your voice agents.

Function calling

Function Calling with Bolna Voice AI Agents

Learn how to use your knowledgebases with Bolna Voice AI agents to provide accurate, context-aware, and data-driven responses for seamless interactions.

Integrating knowledgebases

Integrating Knowledgebases with Bolna Voice AI

Discover how to set guardrails for Bolna Voice AI agents, ensuring safe, reliable, and compliant interactions tailored to your business needs.

Implementing Guardrails

Implementing Guardrails for Bolna Voice AI Agents

Learn how to receive real-time call data updates from Bolna Voice AI using webhooks. Monitor and handle call scenarios effectively.

Polling for call status

Using webhooks for call status with Bolna Voice AI

Integrate custom large language models (LLMs) into Bolna Voice AI to enhance agent capabilities and tailor responses to your unique requirements

Using custom LLMs

Using Custom LLMs with Bolna Voice AI

Explore multi-agent prompt setups in Bolna Voice AI to enable dynamic conversations between multiple agents for advanced use cases.

Multi agent prompt

Creating Multi-Agent Prompts in Bolna Voice AI

Discover how Bolna Voice AI supports multiple languages. Enable global interactions with multilingual capabilities tailored to your audience.

Multilingual support

Multilingual Language Support in Bolna Voice AI

Review the telephony providers compatible with Bolna agents, including Twilio and Plivo. Integrate seamlessly to initiate inbound and outbound Voice AI calls.

Telephony setup

Explore Telephony Integrations with Bolna Voice AI

Purchase and manage phone numbers directly from Bolna's dashboard. Follow step-by-step instructions to secure numbers for your Voice AI agents.

Purchase phone numbers

Acquire Dedicated Phone Numbers through Bolna

Make outbound Voice AI calls with Bolna using default or dedicated phone numbers. Integrate telephony providers and automate calls via dashboard and APIs.

Making Outgoing calls

Make Outbound Calls Using Bolna Voice AI Agents

Set up Bolna Voice AI agents to answer incoming calls. Assign phone numbers, configure settings via the dashboard or API, and enhance customer interactions.

Receive Incoming calls

Handle Inbound Calls with Bolna Voice AI Agents

Learn how to schedule and manage batch calls using Bolna's Voice AI agents. Upload CSV files, set call parameters, and monitor execution for efficient outreach.

Batch Calling

Automate and schedule calls using Batches

Discover methods to disconnect live Bolna Voice AI calls. Implement time-based hangups, custom prompts, and personalized messages for seamless call termination.

Hangup live calls

Hangup and Disconnect Bolna Voice AI calls

Optimize call lengths with Bolna Voice AI by setting duration limits. Automatically terminate calls exceeding limits for better resource management.

Terminate live calls

Terminate Bolna Voice AI calls

Learn to create, modify, and test Bolna Voice AI agents using the various capabilities like Agent Setup, Executions, Batches, Voice Lab, Phone Numbers and more.

Bolna Playground Overview

Step-by-step guide to creating, importing, and managing your Bolna Voice AI agents within the Playground.

Creating agents

Creating your Bolna Voice AI agent

Central hub for creating, modifying, and testing your Bolna Voice AI agents, including prompt customization and variable management.

Agents Tab

Set up Speech-to-Text (STT) configurations, choose transcriber providers, and define language and endpointing settings to be set for Bolna Voice AI agents.

Transcriber Tab

Configure Large Language Model (LLM) settings for your agents, including provider selection, token limits, and response creativity.

LLM Tab

Customize Text-to-Speech (TTS) settings, select voice providers, and adjust buffer sizes for optimal Bolna Voice AI agent performance.

Voice Tab

Manage telephony settings, including providers, call hangup prompts, and termination time limits to be used for phone calls with Bolna Voice AI agents.

Call Tab

Integrate function calling capabilities, such as appointment scheduling and call transfers, into your Bolna Voice AI agents.

Functions Tab

Add follow-up tasks like conversation summaries, information extraction, and custom webhooks for post-call actions to be performed by Bolna Voice AI agents.

Tasks Tab

Access and analyze conversation logs, including call recordings, transcripts, and summaries, for your deployed Bolna Voice AI agents.

Agent executions

Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applicatons and workflows.

Bolna API Documentation

Explore Bolna Voice AI Agent APIs overview, featuring endpoints for creating, managing, and executing autonomous voice agents.

Overview

Bolna Voice AI Agent APIs Overview

Retrieve detailed Voice AI agent information, including configuration, status, and tasks, using Bolna APIs.

Get agent

Retrieve Voice AI Agent Details API

Learn how to create new agents with Bolna APIs, enabling customized tasks, prompts, and configurations for Bolna voice AI agents.

Create agent

Create Voice AI Agent API

Update agent configurations, tasks, and prompts to refine behavior and capabilities using Bolna Voice AI agent APIs.

Update agent

Update Voice AI Agent API

Learn how to partially update properties. Update Bolna Voice AI agent name, welcome message, webhook URL, voice settings, and prompts, using this endpoint.

Patch update agent

Patch Update to Voice AI Agent API

List all Voice AI agents under your account, along with their names, statuses, and creation dates, using Bolna APIs.

List agents

List all Voice AI Agents API

Fetch specific execution details of a Voice AI agent, including conversation times, statuses, and metrics, via Bolna APIs.

Get agent execution

Retrieve Voice AI Agent Execution API

Access all execution records for a specific agent, providing insights into performance and past interactions with Bolna APIs.

Get all executions

Get All Voice AI Agent Executions API

Use Bolna APIs to delete agents and their related data, ensuring proper cleanup of batches, executions, and configurations.

Delete agent

Delete Voice AI Agent API

Explore Bolna Calling APIs to invoke outbound Voice AI phone calls from your agents. This overview provides the available endpoints and their functionalities.

Calling APIs overview

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.

Make phone call

Make Voice AI Call API

Access your Voice AI agents call and conversation history using Bolna Executions APIs. This page details the available endpoints for managing call executions.

Executions APIs overview

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.

Get execution

Retrieve Voice AI Execution API

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 batch executions

Get Batch Executions API

Retrieve all executions performed by a specific agent using Bolna APIs. This endpoint provides a comprehensive history of the agent's calls and conversations.

Get all agent executions

Manage your phone numbers effectively using Bolna APIs, including listing and associating numbers with Bolna Voice AI agents.

Phone Numbers APIs Overview

Retrieve all phone numbers associated with your account, including details like creation date and telephony provider like Twilio, Plivo, etc.

List phone numbers

List Phone Numbers API 

Discover how to set up Bolna Voice AI agents to answer inbound calls, enabling responsive communication channels.

Inbound Bolna Voice AI Agent APIs Overview

Configure Bolna Voice AI agent to handle inbound calls automatically by associating it with a specific phone number using Bolna APIs.

Set inbound agent

Set Inbound Agent API

Understand how to create and schedule multiple Bolna Voice AI calls together using Bolna Batch APIs for efficient call management.

Batch APIs Overview

Find out how to retrieve details of a specific batch, including its creation time, status, call status and scheduled execution time.

Get batch

Get Batch API

Learn how to schedule a batch for calling via Bolna Voice AI agent by specifying the batch ID and the desired execution time.

Schedule batch

Schedule Batch API

Understand how to stop a running batch using its ID, allowing you to halt ongoing calls in the batch.

Stop batch

Stop Batch API

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 all batches

List All Batches API

Learn how to retrieve all executions from a batch, providing detailed information on each call's outcome and metrics.

List batch executions

List Batch Executions API

Understand how to delete a specific batch using its ID, effectively removing it from your scheduled or active batches.

Delete a batch

Delete Batch API

Learn how to ingest and add knowledgebases to Bolna Voice AI agents, enhancing their information base and response accuracy.

Knowledgebases

Knowledgebases Overview

Upload a PDF document to create a knowledgebase, enhancing your Bolna Voice AI agent's information base and response accuracy.

Create Knowledgebase

Create Knowledgebase API

Retrieve details of a specific knowledgebase, including its ID, file name, creation time, and status, using Bolna APIs.

Get knowledgebase

Get Knowledgebase API

Retrieve all knowledgebases associated with your account, including their status and creation dates.

List all knowledgebases

List All Knowledgebases API

Remove and delete an existing knowledgebase from your Bolna account maintaining your Bolna Voice AI agents upto date.

Delete knowledgebase

Delete Knowledgebase API

Add and manage your own providers securely in Bolna, supporting various telephony and voice services.

Providers APIs overview

Learn how to securely add a new provider to your Bolna account by specifying the provider's name and associated credentials.

Add a new provider

Add a New Provider API

Retrieve all providers associated with your Bolna account, including their IDs, names, and creation timestamps.

List providers

List Providers API 

Delete a previously added provider from your Bolna account, ensuring your integrations remain current.

Remove a provider

Remove a Provider API

Enterprise-only account APIs for accessing voices and generating test transcripts which can be utilized for Bolna Voice AI agents.

User APIs overview

User APIs Overview

Retrieve a list of all available voices for your account, including details like provider, language, and accent.

API Documentation

Current APIs

Legacy APIs (deprecated)

Create Batch API

Authorizations

Body

Response