API Documentation

The Convoi AI Public API

Create voice calls, manage agents, and integrate Convoi AI into your product from any backend. REST over HTTPS, JSON in and out, authenticated with bearer tokens.

Getting Started

Authenticate, make your first request, and understand the shape of the API.

Introduction
Welcome to the Convoi AI Public API, what it is, how it's organized, and where to start.
3 min read→
Quickstart
Make your first API call in under five minutes.
5 min read→
Authentication
Use bearer tokens to authenticate every Public API request.
3 min read→

Calls

Create, list, and manage web and outbound phone calls.

Create a Web Call
Connect a browser participant to a Convoi agent over LiveKit.
6 min read→
Outbound Phone Calls
Dial an E.164 phone number from one of your provisioned Convoi numbers.
6 min read→
List & Manage Calls
Read past calls, fetch a single call, and end an in-progress call.
4 min read→

Resources

Read-only resources: agents and phone numbers attached to your account.

Agents
Read agents attached to your account.
3 min read→
Phone Numbers
List phone numbers provisioned to your account.
2 min read→

Reference

Errors, status codes, and the interactive OpenAPI reference.

Errors
Every error response follows RFC 7807 Problem Details.
4 min read→
Rate Limits
Per-token rate limits and monthly quotas.
3 min read→

Ready to build?

Try every endpoint in the interactive reference

Browse schemas, copy code samples, and send live requests with your bearer token from the OpenAPI explorer.

Open API Reference Contact support

Getting Started

Introduction

Quickstart

Authentication

Calls

Create a Web Call

Outbound Phone Calls

List & Manage Calls

Resources

Agents

Phone Numbers

Reference

Errors

Rate Limits

Try every endpoint in the interactive reference