LiteBot — User Manual
Covers LiteBot 1.0.0 (commit fa1f9a9), run as the litebot binary under pm2.
LiteBot runs AI chat and voice bots for customer service. Each bot has its own prompt, language model, tools and knowledge base. Bots answer over a REST and WebSocket chat API, over a realtime voice WebSocket, and as the brain of phone calls placed or answered by the VEXYL Voice Gateway. A React dashboard manages bots, tools, documents, users, tenants, outbound campaigns and analytics.
Pick the column that matches your job, then read the marked chapters.
Bots
Prompt, model, tools and knowledge per bot, edited live from the dashboard.
Tools
Small JavaScript functions a bot calls to book, look up or hand off.
Knowledge Base
Upload documents; bots search them while answering.
Voice
Realtime voice sessions, and the brain behind VEXYL gateway phone calls.
| Chapter | What it answers | Operator | Bot builder | Developer |
|---|---|---|---|---|
| 01 Overview | What LiteBot does, how a chat turn and a voice call move through it, and what to have ready | ✓ | ✓ | ✓ |
| 02 Quickstart: binary | How to go from the litebot bundle to a running server under pm2 with a first admin and a test chat |
✓ | ||
| 03 Dashboard | What each dashboard page shows, what it lets you change, and which role it needs | ✓ | ✓ | |
| 04 Users, roles and tenants | How login, API keys, roles, permissions and tenants work, and what each tenant can see | ✓ | ✓ | |
| 05 Bots | Where bots come from, how to create and edit one, prompts, variables, tools, routing and reload | ✓ | ✓ | |
| 05b Bot config reference | Every key a bot configuration accepts, with type, default and meaning | ✓ | ✓ | |
| 06 LLM providers | Which model providers exist, their variables, failover, health and per-tenant keys | ✓ | ✓ | |
| 07 Tools | How to write, register, test and limit a tool that a bot can call | ✓ | ✓ | |
| 07b Session-end hooks | How to run tools when a conversation ends, such as sending a call summary | ✓ | ✓ | |
| 08 Knowledge base | How to load documents, choose the vector store and embeddings, and let a bot search them | ✓ | ✓ | |
| 09 Visual flows | How flow bots are drawn, stored and run, and their current limits | ✓ | ||
| 10 Chat API | How to send messages over REST, streaming and WebSocket, and how to end a session | ✓ | ||
| 11 Voice | How the /voice realtime WebSocket works and how the VEXYL gateway uses LiteBot for calls |
✓ | ✓ | |
| 12 Outbound auto-dialer | How to run outbound call campaigns from a CSV, with per-provider voice and model | ✓ | ✓ | |
| 13 Conversations and analytics | What LiteBot records per conversation and turn, and how to read history, traces and evidence | ✓ | ✓ | ✓ |
| 14 HTTP API | Every REST route with method, path and permission | ✓ | ||
| 15 Operations | Logs, health probes, provider recovery, restarts, hot reload, backups and safe deploys | ✓ | ||
| 15b Security | What LiteBot exposes, how to lock each part down, and what data it keeps | ✓ | ✓ | |
| 16 Troubleshooting | What a symptom means and which section fixes it | ✓ | ✓ | ✓ |
| 17 Environment reference, part 1 | Variables for server core, auth, database, providers and knowledge base | ✓ | ||
| 17b Environment reference, part 2 | Variables for chat behaviour, voice, tools, modules and logging | ✓ | ||
| 18 Cost and performance | How cost is computed per request, the performance targets, and the settings that move them | ✓ | ✓ |