API and protocol reference
Look up signatures, frame fields, codes, catalog values and tools here. For task-oriented guidance, start with Build an agent or Troubleshooting.
- Brain API: every callback, its signature, and what it is handed.
- The wire: every frame each end sends, and what it obliges.
- RTVI messages: the message whitelist, both directions.
- Voice, language and character catalog: the voices, the languages, the avatar characters and the turn-taking settings, live from
catalog.get. - Error codes: every code, what raised it, and whether it ends the session.
- HTTP API:
sessions.connect, the one route that takes a key. - MCP server: every management tool, and what it reads or writes.