The unique identifier for the batch to be cancelled.

Headers

Path Parameters

Response

Community & Support

Blog

AMHLB Prompting Guide

Full Code Examples

Zapier No-code integration

Enterprise inquiries

Bland AI

V1 API Reference

GET YOUR KEYS

Support

Stop Active Batch

Welcome to Bland AI

Learn how to use Bland's API in under  five minutes

Starter guide

Custom Twilio Integration

Fine-tuning & Custom LLMs

Custom languages & voices

Bring your own Twilio

Enterprise rate limits

Bland & Botpress

Gain greater control over your AI agent and the conversational flow. [Create a Pathway Now!](https://app.bland.ai/dashboard?page=convo-pathways)

Conversational Pathways

Interact with the real world mid-call using custom tools.

Custom Tools

Send your first phone call

Webhook Signing

Send 1000 phone calls

Interact with the real world by connecting your agent to external APIs.

Dynamic Data

Setting max duration

Live transfer

Webhooks

Send an AI phone call with a custom objective and actions.

Send Call (Simple)

Send an AI phone call with your own conversational pathway agent! Links - [Video Tutorial](https://www.loom.com/share/5ce5a84ec97149efad7cf5eff66a93c5?sid=697dc436-53cf-494c-a3e9-a25031df6496) | [Step-by-step web tutorial](https://docs.bland.ai/tutorials/pathways)

Send Call using Pathways (Simple)

Send Call

Analyzes a call of calls based using questions and goals.

Analyze Call with AI

Stop Active Call

End all active phone calls on your account.

Stop All Active Calls

Returns a set of metadata for each call dispatched by your account.

List Calls

Retrieve detailed information, metadata and transcripts for a call.

Call Details

Retrieve stream of events that occured during the call.

Event Stream

Audio Recording

Get corrected transcripts

Create a Vector Store

Update Vector Store

List Vector Stores

View the details for a specific vector store.

List Vector Details

Delete Vector Store

Returns a set of information about all the conversational pathways in your account - including the name, description, nodes and edges.

Get All Pathways Information

Returns a set of information about the conversational pathway in your account - including the name, description, nodes and edges.

Get Single Pathway Information

Create Pathway

Update a conversational pathway's fields - including name, description, nodes and edges.

Update Pathway

Delete Pathway

Create an instance of a pathway chat, which can be used to send and receive messages to the pathway.

Create Pathway Chat

Send a message to a pathway and receive a response.

Pathway Chat

Get conversation history for a pathway chat.

Retrieves all versions of a specific pathway, including version number, creation date, name, and latest status.

Get Pathway Versions

Retrieves a specific version of a pathway, including its name, nodes, edges, version number, and latest status.

Get Specific Pathway Version

Promote a pathway version for a pathway ID to either staging or production environment.

Promote Pathway Version

Creates a new version of a specific pathway, including its name, nodes, and edges.

Create Pathway Version

Marks a specific version of a pathway as archived, effectively deleting it from active use.

Delete Pathway Version

Retrieves all folders for the authenticated user, including folder ID, name, and parent folder ID.

Get All Folders

Retrieves all pathways within a specific folder for the authenticated user.

Get Pathways in Folder

Creates a new folder for the authenticated user.

Create Folder

Deletes a specific folder for the authenticated user. The folder must be empty to be deleted.

Delete Folder

Updates the name of a specific folder for the authenticated user.

Update Folder

Moves a pathway to a different folder or to the root level.

Move Pathway

Purchase and configure a new inbound phone number. ($15/mo. subscription using your stored payment method).

Purchase Inbound number

Update your inbound agent's settings, prompt and other details.

Update Inbound Details

Retrieves a list of all inbound phone numbers configured for your account, along with their associated settings.

List Inbound Numbers

Retrieve settings for your inbound phone number.

Inbound Number Details

Purchase Outbound number

Retrieves a list of all outbound phone numbers configured for your account, along with their associated settings.

List Outbound Numbers

Retrieves all available voices for your account.

List Voices

Retrieve detailed information about a specific voice.

Voice Details

Publish Cloned Voice

Generate Audio Sample

Create a Custom Tool that can take AI input and call external APIs.

Create a Custom Tool

Change your Custom Tool's parameters and characteristics.

Update Custom Tool

Delete Custom Tool

List Custom Tools

Custom Tool Details

Configure all of the settings for a new web agent.

Create a Web Agent

Update your web agent's settings, prompt and other details.

Update Web Agent Settings

Create a single-use session token for a client to talk with your web agent.

Authorize a Web Agent Call

Delete Web Agent

Retrieves each web agent you've created, along with their settings.

List Web Agents

Integrate your own Twilio account with Bland. See [Enterprise Twilio Integration](/enterprise-features/custom-twilio) for more information.

Create Encrypted Key

Disable an encrypted key for a Twilio account integration. See [Enterprise Twilio Integration](/enterprise-features/custom-twilio) for more information.

Delete Encrypted Key

Add inbound numbers to Bland from your own Twilio account. See [Enterprise Twilio Integration](/enterprise-features/custom-twilio) for more information.

Upload Inbound Phone Numbers

Remove an inbound number that was uploaded through your own Twilio account. See [Enterprise Twilio Integration](/enterprise-features/custom-twilio) for more information.

Delete Inbound Phone Number

Provision a new subaccount with separate billing, access and usage.

Create Subaccount

Transfer API credits from your account to a subaccount.

Transfer Credit to a Subaccount

Transfer a phone number from your account to a subaccount.

Transfer Phone Number to a Subaccount

Replace the API key of a subaccount with a new one.

Rotate Subaccount API Key

Immediately disables a subaccount and transfers any remaining credits back to the parent account.

Disable Subaccount

View all your subaccounts and their details.

List Subaccounts

List Subaccount Details

Send large volumes of calls at once with a single API request.

Send a Batch of Calls

Analyzes a batch of calls based on using questions and goals.

Analyze Batch with AI

Retrieves batch-specific data for each batch you've created.

List Batches

Retrieves calls and batch data for a specific batch_id.

Batch Details

Retrieves the analyses for a specific batch of calls, including details of each call's analysis.

Retrieve Batch Analysis

Send large volumes of calls at once with follow-up sequences.

Create a Campaign

Stops a campaign and all associated calls.

Stop Campaign

Retrieve all campaigns and high level numerical metrics associated with each.

List Campaigns

Returns specific campaign with all associated calls within campaign.

Campaign Details

Learn how to register your A2P brand using our API. This guide covers all you need to know about making a POST request, including required parameters, error handling, and response expectations.

A2P Registration

Check SMS A2P status

Update SMS Number

Hides all messages in an SMS conversation from the AI's future responses (without permanently deleting them). For development/debugging.

Basic

Calls

Vector Stores

Conversational Pathways

Inbound Numbers

Outbound Numbers

Voices

Custom Tools

Web Agents

Custom Twilio Accounts

Subaccounts

Batches

Campaigns

SMS

Prompts

Account

Stop Active Batch

Headers

Path Parameters

Response

Basic

Calls

Vector Stores

Conversational Pathways

Inbound Numbers

Outbound Numbers

Voices

Custom Tools

Web Agents

Custom Twilio Accounts

Subaccounts

Batches

Campaigns

SMS

Prompts

Account

​Headers

​Path Parameters

​Response

Headers

Path Parameters

Response