getting started
Roxels documentation
Roxels is a voice-AI platform you embed in your product. You author a conversation in the dashboard, then run it as a widget, as a custom UI on top of a headless controller, or entirely server-side through the REST API.
If you have five minutes, the Quickstart takes you from sign-up to a working embed.
By integration path
- Embed the widget — Drop in a
<script>tag. Roxels handles the UI. - Headless mode — Roxels runs the call; you draw every pixel of the UI.
- REST API — Manage templates and conversations from your backend.
- Webhooks — Receive structured results as goals commit.
- MCP package — Author templates from Claude Code, Cursor, or any MCP client.
By concept
- What is Roxels — Templates, conversations, outputs. The product in one page.
- Conversation lifecycle — A single conversation end to end.
- Identity and resumption — How participants are tracked across sessions.
- Templates — How you describe what a conversation does.
Reference
- Embed JS API — Every
Roxels.*method and controller method. - Events — Every event the embed emits.
- MCP tools — Every tool the MCP package exposes.
- Troubleshooting — Common issues and how to resolve them.
If you don't know which page to read first, start with the Quickstart.