Documentation

The Brisvox documentation is a book: quickstart, concepts, configuration, telephony, operations, benchmarks and reference. It is built from the docs/ folder of the repository, so the same text is on GitHub and in the book.

Last updated:

Start here

From nothing to a call you can talk to.

Concepts

Short pages for the mental model.

Build and configure

The agent file, the tools and the callers.

Connect callers

Phone lines, browsers and your own clients.

Run in production

Deploying, watching and securing the server.

Reference and design

Why it behaves the way it does.

What to build with

The default build has no providers and no listeners beyond the websocket: you choose cargo features for what you want to run. The prebuilt binaries and the container image are built with all-providers,call-control,smart-turn-ort,mcp,webrtc.

GoalCargo featuresRead
A voice button on a website (WebRTC with a WebSocket fallback)all-providers,smart-turn-ort,webrtcWeb assistant example
A phone number through Twilio or Telnyx (transfer, DTMF, hang-up)all-providers,call-control,smart-turn-ortPhone receptionist example
A SIP trunkall-providers,call-control,smart-turn-ort,sipTelephony
Fully local speech, no API keyprovider-sherpa-onnx,provider-openai-compatible,provider-openai-speech,smart-turn-ort,webrtcA fully local assistant
Your own tools in Python or TypeScriptThe features of the goal above; tools come from an SDK processBooking agent example
Your own tools in Rust, in one binaryYour crate depends on brisvox with the provider features your agent file namesRust tools example
Not in the prebuilt set: sip, otlp (OpenTelemetry export) and recording-encryption. Build from source with them added when you need them.

For AI coding agents

Point your agent at these and it can work on a Brisvox project without prior knowledge.