Bolna Docs

API Reference

Changelog

Try Bolna on the Playground

Get batch

bearerAuth

Bolna is the end-to-end open source production ready framework for quickly building LLM based voice driven conversational applications.

Introduction

Platform Concepts

Pricing

Leverage and scale Bolna Voice AI for your applications

Enterprise

Some pointers to get you started on your journey to creating and deploying Bolna agents

Tips & Tricks for Agent Creation

You can use these agents as templates for your use-cases

Agent templates

You can use your own providers for agents and lower your costs

Connect your Providers

Learn how to inject variables and other useful context in conversations

Adding variables

Injecting dynamic variables and user context

Learn how to extract details from conversations

Extracting call details

Extracting and retrieving details from calls

Learn how to use functions with Bolna and connect large language models to external tools

Function calling

Learn how to ingest your PDFs and use them in Agent context

Using your knowledgebases

Learn how to use guardrails preventing harmful, inappropriate, or unintended outputs

Guardrails

Get real-time updates for call data using webhooks

Webhooks for call data

Poll call data using webhooks

Use Bolna Voice AI with your own custom LLM

Using custom LLMs

Using your own custom LLM

Learn how to create complex agents using multiple prompts

Multi agent prompt

Building multi-agent prompt

An overview of Bolna's supported languages.

Multilingual support

Language overview

Use Bolna to initiate calls to & from phone numbers

Telephony setup

Telephony providers & setup

Purchase phone numbers to make & receive calls using your own dedicated phone numbers

Purchase phone numbers

Purchase phone numbers on Bolna

Use Bolna Voice AI agents for your outgoing phone calls

Making Outgoing calls

Make outbound calls using Bolna Voice AI agents

Use Bolna Voice AI agents for your incoming phone calls

Receive Incoming calls

Receive inbound calls using Bolna Voice AI agents

Scheduling batches for your agent to call using APIs

Batch Calling

Hangup and disconnect Bolna AI incoming and outgoing calls

Hangup live calls

Hangup live calls on Bolna

Terminate Bolna AI incoming and outgoing calls

Terminate live calls

Terminating live calls on Bolna

Create and deploy your Voice AI agents using playground

This is your home page! Create, modify or test your agents

Creating agents

Creating your Bolna Voice AI agent

Your home page! Create, modify or test your agents

Agents Tab

Transcriber Tab

LLM Tab

Voice Tab

Call Tab

Functions Tab

Add follow up tasks for summary, extraction, etc

Tasks Tab

Agent executions

Bolna API Documentation

Use Agent APIs to create autonomous Bolna Voice agents

Overview

Agent APIs overview

Get agent

Create agent

Update agent

List agents

Get agent execution

Get all executions

Use call APIs to invoke outbound phone calls from your Agents

Calling APIs overview

Initiate Call

Use Executions APIs to get all your agent call & conversations history

Executions APIs overview

Retrieve specific execution by `execution_id`

Get execution

Get all batch executions

Get all agent executions

Phone numbers APIs overview

List phone numbers

Inbound agent APIs overview

Set inbound agent

Create and schedule multiple calls together

Batch APIs overview

Create batch

Schedule batch

Stop batch

List all batches

List batch executions

Delete a batch

Knowledgebases

Create Knowledgebase

Get knowledgebase

List all knowledgebases

Delete knowledgebase

Providers APIs overview

Add a new provider

List providers

Remove a provider

Enterprise-only account APIs for accessing voices

API Documentation

Current APIs

Legacy APIs

Get batch

Authorizations

Path Parameters

Response