API Reference

Open Source

Community

Contact

Vocode

Star us on GitHub!

Get Recording

Location

Message

Error Type

ValidationError

HTTPBearer

HTTPValidationError

Vocode is an open-source library for building voice Agents.

Welcome

Hosted Quickstart

How to get Vocode up and running on your own machine

Open Source Quickstarts

The one-stop solution for building voice Agents

What is Vocode

How it works

How to Use It

Python Quickstart

React Quickstart

How to use agents with inbound and outbound phone calls.

Working with phone calls

Using WebRTC with LiveKit

How to use Vocode in non-streaming applications

Turn-based conversation

How to create a custom Agent for your use case.

Create your own AI Agent

Connecting Your Agent

Use LangChain to determine your agent's responses.

LangChain Agent

How to control the voice of your application.

Using synthesizers

How to configure and use transcribers for speech recognition in your application.

Using transcribers

Empower agents to take actions during conversations.

Adding Actions to Agents

Activate actions with function calls or specific phrases

Action Triggers

Have your agent communicate with an External API

External Actions

How to tune the responsiveness in Vocode conversations

Conversation Mechanics

Multilingual support

Make logging set up less painful for local and production usage!

Logging with Loguru

Integrate Sentry for error tracking and performance monitoring

[Beta] Sentry Integration

⛱ Play with individual Vocode components

Playground

Events manager

Empower Langchain agents to interact with the real world via phone calls

(Deprecated) Langchain Agent

💃 Run a voice agent on your computer without Internet

Fully local conversation

List Numbers

Get Number

Buy Number

Link Number

Update Number

Cancel Number

List Calls

Get Call

End Call

Create Call

Get Usage

Get Action

List Actions

Create Action

Update Action

Get Agent

List Agents

Create Agent

Update Agent

Get Prompt

List Prompts

Create Prompt

Update Prompt

Get Vector Database

List Vector Databases

Create Vector Database

Update Vector Database

Get Voice

List Voices

Create Voice

Update Voice

Get Webhook

List Webhooks

Create Webhook

Update Webhook

Get Account Connection

List Account Connections

Create Account Connection

Update Account Connection

Intro

Setting up your number

Setting up our agent to function as a receptionist

Configuring your number

Setting up a webhook

Powerful AI assistants that you can control

Agents

Prompts

Prompt Engineering

Make your agents sound the way you want them to

Voices

Listen to events on your phone calls and set up automations

Webhooks

Give your agents the ability to execute actions

Actions

Configure Vocode actions to run based on different triggers

Customize your bot's conversational behavior

Conversational Dials

Get information on in-progress and completed calls

Retrieve Call Data

Define the behavior of the bot when no one answers the phone

Answering Machine Detection

Configure whether or not to run automatic estimated Do Not Call analysis

Do Not Call Detection

Use your own Twilio account and phone numbers with Vocode

[Enterprise] Bring Your Own Telephony

Use your own OpenAI keys and models with Vocode

[Enterprise] Bring Your Own OpenAI API Keys

[Beta] External Actions

Conference another party into an outbound call

[Beta] Warm Transfer

How to make bots speak different languages

[Beta] Multilingual bots

[Beta] Injecting context

[Beta] IVR Navigation

Give your agents knowledge via embeddings

Numbers

Calls

Usage

Actions

Agents

Prompts

Vector Databases

Voices

Webhooks

Account Connections

Get Recording

Authorizations

Query Parameters

Response