Documentation Index
Fetch the complete documentation index at: https://docs.bithuman.ai/llms.txt
Use this file to discover all available pages before exploring further.
Every example below is open source in bithuman-product/bithuman-examples. The Swift / Apple Silicon examples live in bithuman-product/bithuman-apps.
bitHuman Cloud (managed)
No local runtime — call the REST API or use the LiveKit plugin.
| Example | Model | What it does | Source |
|---|
| Agent Management | — | Validate credentials, get/update agents | api/ |
| Agent Generation | — | Create agents from prompt, poll status | api/ |
| Dynamics | Essence | Generate gestures, list available gestures | api/ |
| Essence + Cloud Plugin | Essence (CPU) | LiveKit avatar with hosted Essence agent | essence-cloud/ |
| Expression + Cloud Plugin | Expression (GPU) | LiveKit avatar with hosted Expression agent or any face image | expression-cloud/ |
Self-hosted server
Run the runtime on your own hardware.
| Example | Model | What it does | Source |
|---|
| Essence + Self-Hosted | Essence (CPU) | Python SDK — push audio, render avatar locally | essence-selfhosted/ |
| Audio Clip | Essence (CPU) | Play a .wav through an avatar with OpenCV display | essence-selfhosted/ |
| Live Microphone | Essence (CPU) | Real-time mic input → avatar | essence-selfhosted/ |
| AI Conversation | Essence (CPU) | OpenAI voice chat → avatar | essence-selfhosted/ |
| Raspberry Pi | Essence (CPU) | Edge deployment on Raspberry Pi | — |
| Expression + Self-Hosted GPU | Expression (GPU) | Linux + NVIDIA Docker, dynamic face from any image | expression-selfhosted/ |
On-device Apple Silicon
Everything runs on the user’s Mac, iPad, or iPhone — only the billing heartbeat goes out.
| Example | Surface | What it does | Source |
|---|
| Expression on macOS (on-device) | Swift SDK | Floating avatar window, drag-drop face swap, Sparkle DMG | bithuman-apps/Mac |
| iPad reference app | Swift SDK | Stage Manager 320×320 panel, Picture-in-Picture, PhotosPicker portrait swap | bithuman-apps/iPad |
| iPhone reference app | Swift SDK | Full-screen avatar, tap-to-collapse 120 pt PiP | bithuman-apps/iPhone |
| Apple Local Agent | Python | 100% offline on macOS (Siri + Ollama, Essence) | integrations/macos-offline/ |
| bitHuman Halo | Signed DMG | Free macOS desktop app — floating avatar, local STT + LLM + TTS | Install guide |
| bithuman-cli | CLI (Homebrew) | brew install bithuman-cli — voice / video / text modes | /swift-sdk/cli |
Web & framework integrations
| Example | What it does | Source |
|---|
| Web UI | Browser-based Gradio interface | integrations/web-ui/ |
| Java Client | WebSocket streaming from Java | integrations/java/ |
| Next.js UI | Drop-in LiveKit web interface | integrations/nextjs-ui/ |
Prerequisites
New to bitHuman? Start with Essence + Cloud — the simplest setup with no models to download. Building a Mac/iPad/iPhone app instead? Jump to the Swift SDK quickstart.