Docs index: /llms.txt · every page as Markdown: add .md

Docs
Console Discord Get API secret
‹ Overview

For AI agents

Everything an AI agent needs to read these docs and build with bitHuman.

View as Markdown Open in ChatGPT Open in Claude

Everything on this site is available in a form an agent can read without parsing HTML.

Markdown for every page

  • Add .md to any page’s URL: /platforms/python.md. Each HTML page links its twin with rel="alternate".
  • Or ask for markdown: a request with Accept: text/markdown gets the same text at the page’s own URL.
curl -H "Accept: text/markdown" https://docs.bithuman.ai/platforms/python

Files

FileWhat it holds
/llms.txtThe index: rules for agents, where each model runs, key facts, one command per platform, speed, and links
/llms-full.txtGetting started, the Python, CLI, Windows, LiveKit, Pipecat and REST platform pages, and the REST API in one file
/llms/start.txt, /llms/platforms.txt, /llms/apps.txt (iOS & iPadOS, macOS, Android, Flutter, Web), /llms/deploy.txt, /llms/models.txt, /llms/build.txt, /llms/api.txtThe same text one section at a time
/api/openapi.yamlThe REST API as OpenAPI 3
/versions.jsonThe current version and install line of every artifact
/platforms.jsonEvery way to run bitHuman, with its first command and docs
/performance.jsonThe speed of every published configuration (× real time), with hardware, release and date
/changelog.xmlEvery release as an RSS feed, tagged by platform
ShowcaseSample avatars anyone can use: slug, agent code, model

Docs MCP

The docs are also an MCP server with two read-only tools: search finds pages, and fetch returns one as markdown. It needs no account and no key.

ClientAdd it
Claude (claude.ai, desktop)add bitHuman docs from the Connectors Directory
Claude Codeclaude mcp add --transport http bithuman-docs https://docs.bithuman.ai/docs-mcp
Cursor, VS Code and other clientsa remote (Streamable HTTP) server at https://docs.bithuman.ai/docs-mcp
{ "mcpServers": { "bithuman-docs": { "url": "https://docs.bithuman.ai/docs-mcp" } } }

It is also on the official MCP Registry as ai.bithuman/docs.

To drive bitHuman itself (create agents, render videos) from an MCP client, use the CLI’s own server instead: MCP server.

Agent skill

bithuman-integrate is a skill an agent loads before it adds an avatar to a project: it picks the path, installs, wires 16 kHz speech to frames and handles the API secret. Save it as .claude/skills/bithuman-integrate/SKILL.md in a project, or ~/.claude/skills/bithuman-integrate/SKILL.md for every project:

mkdir -p .claude/skills/bithuman-integrate
curl -fsSL https://docs.bithuman.ai/skills/bithuman-integrate/SKILL.md -o .claude/skills/bithuman-integrate/SKILL.md

Rules for agents

  1. Send model ("essence-2" or "expression-2") on every agent you create, and poll until status is ready or failed.
  2. API and SDK use requires the Creator plan or higher.
  3. Read the API secret from the environment (BITHUMAN_API_SECRET); never write it into code or a command line. In a LiveKit worker the secret is read as BITHUMAN_MASTER_SECRET (the same secret under another name, so the plugin never copies it into the room) and the plugin gets a minted token (LiveKit).
  4. When explaining, say where the avatar renders and where the conversation runs: the avatar renders (device, browser, server, cloud); the conversation runs (your stack, the CLI’s local conversation brain, or bitHuman’s servers).
  5. Take versions from /versions.json, speed from /performance.json and prices from GET https://api.bithuman.ai/v1/pricing (send the api-secret header; without it the call returns 401), not from memory or an older sample.

Next