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

‹ Overview

Glossary

The words used across the bitHuman docs and what each one means.

What each term means here, and the page that owns it. The short version, for a first read, is Key terms.

Models and avatars

TermMeaning
Essence 2 (essence-2)The model that renders a photoreal person from one portrait. Essence 2
Expression 2 (expression-2)The model that renders any character from one portrait. Expression 2
Essence 1, Expression 1 (essence-1, expression-1)The first generation of the models. First generation
AvatarThe face that talks: one character, made from one portrait. It turns speech audio into lip-synced video.
AgentAn avatar together with its persona, voice and knowledge, created in the bitHuman app or with the Agents API.
Agent codeThe identifier of an agent, for example A23WJF0199. Request fields name it agent_id or agent_code, and examples read it from BITHUMAN_AGENT_ID or BITHUMAN_AGENT_CODE: all take the same code. Agent codes
Sample avatarsPublic agents anyone can use without an account: wise-pup (agent code A23WJF0199, Expression 2) and sofia-ramirez (A52DHS2219, Essence 2). The CLI takes either the name or the code. Showcase list
Avatar file (.imx)One agent’s model files in one container, downloaded once and rendered on your hardware. The Essence 2 SDKs call it an identity. The avatar file
PersonaThe agent’s system prompt: who it is and how it answers. Persona
GesturesA named motion (wave, nod, clap) an avatar plays when your code asks; the API calls them dynamics. Gestures
IdleThe motion an avatar shows between replies, so it never freezes.

Where it runs

TermMeaning
Renders / runsThe avatar renders (on the device, in the browser, on your server or in the bitHuman cloud); the conversation runs (in your stack, in the CLI’s local conversation brain, or on bitHuman’s servers).
On the deviceThe avatar renders on the user’s iPhone, iPad, Mac or Android phone. On the device
CPU only (no GPU)The avatar renders on a standard Linux PC with no graphics card. CPU only
Self-hosted (your servers)The avatar renders on a computer or server you run: the CLI, the Python SDK, the LiveKit plugin or Pipecat. It bills the lower self-hosted rate. Your servers
bitHuman cloudThe avatar renders on bitHuman’s servers and streams to any screen, at the cloud rate. bitHuman cloud
LiveKit roomA real-time audio and video session on a LiveKit server. A voice agent and the avatar join it as participants, and so do your users. LiveKit
Fully offlineA license for real-time avatars with no internet connection. Fully offline
File renderingTurning an audio file into a talking-avatar video with bithuman render or the Python SDK. It signs in online; it is not the offline license. Talking video
WebGPUThe browser graphics interface the web embed uses to render the avatar in the tab (render=local). Web
Local conversation brainThe CLI mode (BITHUMAN_LOCAL=1) that runs speech recognition, the language model and the voice on a Mac or Linux PC. Local conversation brain
× real timeSeconds of avatar video rendered per second. At 1.0× or more an avatar holds a live conversation. Performance

Credentials and billing

TermMeaning
API secretThe one credential for every surface, read from BITHUMAN_API_SECRET; REST sends it in the api-secret header. Your API secret
Embed tokenA short-lived token your server mints so a web page can open a private agent without the secret. Embedding
Runtime tokenA short-lived token for a LiveKit room or a download, minted with the API secret. Authentication
CreditsWhat usage is paid in: 100 credits = $1. Pricing and credits
SessionOne avatar running, from start to stop. It bills while it runs, talking or idle. Pricing
Managed agent, chat linebitHuman runs the whole conversation (listening, the replies, the voice) and the avatar, for one all-inclusive rate of 10 credits a minute. Pricing
Active session timeWhat real-time usage bills: the time a session is open, talking or idle, to the second. Pricing
Creator planThe plan API and SDK use requires, or a higher one. Plans

Next

This section moved: docs.bithuman.ai/resources/renamed#older-names