{
  "schema": 1,
  "demo_embed": "https://www.bithuman.ai/embed/A23WJF0199",
  "privacy": "https://docs.bithuman.ai/deploy/privacy",
  "versions": {
    "cli": "2.8.3",
    "python": "2.11.16",
    "swift": "2.19.0",
    "essence2_engine": "1.15.0",
    "expression2_swift": "2.19.0",
    "essence2_android": "0.8.1",
    "expression2_android": "0.5.2",
    "livekit_plugin": "1.8.4",
    "flutter_plugin": "2.6.21"
  },
  "platforms": [
    {
      "id": "web",
      "want": "Put an avatar on a website",
      "use": "Web embed",
      "needs": "nothing",
      "first_command": "<iframe src=\"https://www.bithuman.ai/embed/A23WJF0199\" allow=\"microphone *\" style=\"width:100%;height:600px;border:0\"></iframe>",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "renders": "in the bitHuman cloud, or in the visitor's tab with WebGPU (render=local)",
      "conversation": "on bitHuman's servers",
      "credential": "none for a public agent; an embed token for a private one",
      "docs": "https://docs.bithuman.ai/platforms/web",
      "markdown": "https://docs.bithuman.ai/platforms/web.md"
    },
    {
      "id": "rest",
      "want": "Call it from any backend",
      "use": "REST API",
      "needs": "API secret",
      "first_command": "curl -X POST https://api.bithuman.ai/v1/validate -H \"api-secret: $BITHUMAN_API_SECRET\"",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "renders": "in the bitHuman cloud",
      "conversation": "on bitHuman's servers, or with your own provider keys",
      "credential": "API secret, header api-secret",
      "docs": "https://docs.bithuman.ai/platforms/rest",
      "markdown": "https://docs.bithuman.ai/platforms/rest.md"
    },
    {
      "id": "python",
      "want": "Render or stream from Python",
      "use": "Python",
      "needs": "API secret",
      "first_command": "pip install \"bithuman[expression-2]\"",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "renders": "on your machine: macOS (Apple silicon) or Linux x86_64 / arm64",
      "conversation": "your code",
      "credential": "API secret (BITHUMAN_API_SECRET)",
      "docs": "https://docs.bithuman.ai/platforms/python",
      "markdown": "https://docs.bithuman.ai/platforms/python.md"
    },
    {
      "id": "cli",
      "want": "Run it from a terminal",
      "use": "CLI (macOS arm64, Linux x86_64 / arm64)",
      "needs": "sign-in",
      "first_command": "curl -fsSL https://install.bithuman.ai | sh",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "renders": "on your machine: macOS (Apple silicon) or Linux x86_64 / arm64",
      "conversation": "bitHuman's voice chat, your own OpenAI account, or the local conversation brain (BITHUMAN_LOCAL=1)",
      "credential": "bithuman login, or BITHUMAN_API_SECRET",
      "docs": "https://docs.bithuman.ai/platforms/cli",
      "markdown": "https://docs.bithuman.ai/platforms/cli.md"
    },
    {
      "id": "apple",
      "want": "Ship an iPhone, iPad or Mac app",
      "use": "iOS & iPadOS (Swift package)",
      "needs": "Xcode 26+, API secret",
      "first_command": ".package(url: \"https://github.com/bithuman-product/homebrew-bithuman.git\", from: \"2.19.0\")",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "renders": "on the iPhone, iPad or Mac",
      "conversation": "your app's own speech, language and voice services",
      "credential": "API secret, fetched from your backend in a shipped app",
      "docs": "https://docs.bithuman.ai/platforms/ios",
      "markdown": "https://docs.bithuman.ai/platforms/ios.md"
    },
    {
      "id": "android",
      "want": "Ship an Android app",
      "use": "Android",
      "needs": "arm64 device, API secret",
      "first_command": "implementation(\"ai.bithuman:expression2-android:0.5.2\")",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "renders": "on the Android phone (arm64, a physical device)",
      "conversation": "your app's own speech, language and voice services",
      "credential": "API secret, fetched from your backend in a shipped app",
      "docs": "https://docs.bithuman.ai/platforms/android",
      "markdown": "https://docs.bithuman.ai/platforms/android.md"
    },
    {
      "id": "livekit",
      "want": "Add a face to a LiveKit voice agent",
      "use": "LiveKit",
      "needs": "API secret",
      "first_command": "pip install \"livekit-agents[openai,silero]\" livekit-plugins-bithuman python-dotenv",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "renders": "on your server (model_path) or in the bitHuman cloud",
      "conversation": "your LiveKit agent",
      "credential": "BITHUMAN_MASTER_SECRET on the worker; a minted token for a cloud avatar",
      "docs": "https://docs.bithuman.ai/platforms/livekit",
      "markdown": "https://docs.bithuman.ai/platforms/livekit.md"
    },
    {
      "id": "mcp",
      "want": "Drive it from Claude or Cursor",
      "use": "MCP server",
      "needs": "sign-in",
      "first_command": "claude mcp add bithuman -- bithuman mcp",
      "models": [
        "essence-2",
        "expression-2"
      ],
      "docs": "https://docs.bithuman.ai/build/mcp",
      "markdown": "https://docs.bithuman.ai/build/mcp.md"
    },
    {
      "id": "offline",
      "want": "Run fully offline (kiosk, trade show, ATM)",
      "use": "Fully offline",
      "needs": "Business or Enterprise plan; Essence 1 on Linux",
      "first_command": null,
      "contact": "https://www.bithuman.ai/sales",
      "models": [
        "essence-1"
      ],
      "renders": "on your Linux PCs and terminals",
      "conversation": "agreed with sales for your site",
      "credential": "a pack, redeemed once on the machine while it is online",
      "docs": "https://docs.bithuman.ai/deploy/offline",
      "markdown": "https://docs.bithuman.ai/deploy/offline.md"
    }
  ]
}