Skip to main content

bitHuman plugin for LiveKit Agents

Support for bitHuman virtual avatars in LiveKit Agents. The avatar renders either locally, inside your agent's process from a bitHuman .imx model file (no GPU required), or in the bitHuman cloud, where it joins the room as a participant.

See the bitHuman integration docs for more information, and bitHuman's LiveKit guide for a complete agent.

Installation

pip install livekit-plugins-bithuman

To render Expression 2 models locally, also install the SDK's Expression 2 extra:

pip install "bithuman[expression-2]"

Pre-requisites

You'll need an API secret from bitHuman (create one). Store it under a name the plugin doesn't read, such as BITHUMAN_MASTER_SECRET, and pass it as api_secret=. If api_secret isn't passed, the plugin falls back to BITHUMAN_API_SECRET.

In cloud mode the plugin puts api_secret in the avatar participant's attributes, which everyone in the room can read. Pass a one-hour token minted for one agent and one room (POST https://api.bithuman.ai/v1/runtime-tokens/mint, how) instead of the secret, and keep BITHUMAN_API_SECRET unset. Cloud mode also uses LIVEKIT_URL, LIVEKIT_API_KEY and LIVEKIT_API_SECRET.

Usage

Local mode: the avatar renders in this process.

import os

from livekit.plugins import bithuman

avatar = bithuman.AvatarSession(
    model_path="./agent.imx",  # or set BITHUMAN_MODEL_PATH
    api_secret=os.environ["BITHUMAN_MASTER_SECRET"],
)
await avatar.start(session, room=ctx.room)

Cloud mode: the avatar renders on bitHuman's servers.

avatar = bithuman.AvatarSession(
    avatar_id="A23WJF0199",  # your bitHuman agent code (A23WJF0199 is the wise-pup sample)
    api_secret=minted_token,  # from POST /v1/runtime-tokens/mint
)
await avatar.start(session, room=ctx.room)

In both modes the avatar publishes the agent's audio, so start the session with room_options=room_io.RoomOptions(audio_output=False).

Models

  • Essence 2 (essence-2): a photoreal person from one portrait.
  • Expression 2 (expression-2): any character, including people, animals and cartoons, from one portrait.
  • essence / expression: the first-generation Essence 1 and Expression 1. Expression 1 runs in the cloud only.

In local mode the .imx file decides the model. In cloud mode, leave model unset to use the model the agent was created with, or set it to pin one; bitHuman refuses a model the avatar wasn't prepared for. A photo passed as avatar_image (no avatar_id) works only with Expression 1. Pricing: docs.bithuman.ai/pricing.

Metadata

Release files for livekit-plugins-bithuman 1.8.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for livekit-plugins-bithuman 1.8.7
File Size Uploaded
livekit_plugins_bithuman-1.8.7.tar.gz 13.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for livekit-plugins-bithuman 1.8.7
File Interpreter ABI Platform
livekit_plugins_bithuman-1.8.7-py3-none-any.whl Python 3 none any Details

Total release size: 26.2 kB

Release files / livekit_plugins_bithuman-1.8.7.tar.gz

Download URL livekit_plugins_bithuman-1.8.7.tar.gz
Size 13.1 kB
Tags Source
SHA-256 checksum
How to use checksums
82103e6150e15c174851bc7dcb4d038fb2c7f04491c8c6ae4d5972c7ec3a7a0c
BLAKE2b-256 checksum
How to use checksums
425230fa88df030458e97d4d933495ffc1091a1cf920d75d3561f74923d6d28f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.

Transparency log

Release files / livekit_plugins_bithuman-1.8.7-py3-none-any.whl

Download URL livekit_plugins_bithuman-1.8.7-py3-none-any.whl
Size 13.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d8f1205aee5392380d1fad38620c302c6e756755be95983a94119be9ac04da0c
BLAKE2b-256 checksum
How to use checksums
5630da7b8a52df6435ea5e34f83a739d634602b1cc48e3040d725f5d4c3c059e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.

Transparency log

Release history Release notifications | RSS feed

1.8.9

2 release files

1.8.8

2 release files

This release

1.8.7 This release

2 release files

1.8.6

2 release files

1.8.5

2 release files

1.8.4

2 release files

1.8.2

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.10

2 release files

1.6.9

2 release files

1.6.8

2 release files

1.6.7

2 release files

1.6.6

2 release files

1.6.5

2 release files

1.6.4

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.15

2 release files

1.5.14

2 release files

1.5.13

2 release files

1.5.12

2 release files

1.5.11

2 release files

1.5.10

2 release files

1.5.9

2 release files

1.5.8

2 release files

1.5.7

2 release files

1.5.6

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.6

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.12

2 release files

1.3.11

2 release files

1.3.10

2 release files

1.3.9

2 release files

1.3.8

2 release files

1.3.7

2 release files

1.3.6

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.2.17

2 release files

1.2.16

2 release files

1.2.15

2 release files

1.2.12

2 release files

1.2.11

2 release files

1.2.9

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.23

2 release files

1.0.22

2 release files

1.0.21

2 release files

1.0.17

2 release files

1.0.16

2 release files

1.0.15

2 release files

1.0.14

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page