Skip to main content

AlphaAvatar Host

alpha-avatar-host starts AlphaAvatar, owns shared inference, and supervises Avatar executions. Interaction connections belong to session backends; Agents, Core and RTC do not depend on Host. The App is not required to run the service.

📦 Package structure

alphaavatar/host/
├── main.py             # Public alphaavatar command.
├── version.py
├── cli/                # dev/start, arguments, help and version.
├── configs/            # Strict Host/Avatar configuration loading.
├── application/        # Bootstrap, shared services, health and signals.
├── execution/          # Hosted execution ownership and end policies.
├── processes/          # Execution subprocesses, IPC and bounded cleanup.
├── sessions/           # Attachments, modes and backend selection.
│   └── livekit/        # Native dispatch, connections and Character transport.
└── log/                # Console, JSONL, previews and optional event diagnostics.

Startup overview · Package overview

The diagrams are conceptual. Host holds execution handles in the parent process; Engine, Runtime and their session adapters are assembled inside execution children.

Run

Use the repository's Python 3.13 environment and your configured provider credentials:

alphaavatar --help
alphaavatar --version
ENV_FILE=.env.dev alphaavatar dev examples/agent_configs/mm/pipeline_openai_tools.yaml
alphaavatar start examples/agent_configs/mm/pipeline_openai_tools.yaml

dev defaults to DEBUG and an available health port; it does not watch or reload code. start defaults to INFO and port 8081. Help/version do not start models or require RTC credentials. Configuration overrides use key=value after the filename.

Configuration

Keep the existing Avatar settings at the top level and add Host settings beside them:

host:
  rtc:
    backend: livekit
    init_config:
      connection_mode: dispatch
  log:
    events: false
    conversation:
      content: dev
      file_content: false

LiveKit requires LIVEKIT_URL, LIVEKIT_API_KEY and LIVEKIT_API_SECRET. Model and tool providers need their own credentials. Remote endpoints require TLS.

Connection mode Behavior
dispatch Registers using avatar.name and waits for matching explicit dispatches. The assignment supplies the room. Host remains available after a session ends.
direct Requires room_name, optionally selects participant_identity, and exits after its single execution ends. It still requires LiveKit.

The remote participant's session_type metadata selects chat, agent, audio or video; the default is video. This is independent of connection mode and dev/start.

Logs show time, severity, source location, PID and content. dev previews committed user input and recorded assistant text; content: off hides those previews and content: all enables them in both commands. JSONL files are saved under the resolved Avatar workspace's .logs/host/; conversation text is excluded unless file_content: true. Console capture and provider traces have separate retention. Review all logs for personal data before sharing.

host.log.events=true with DEBUG enables sampled Core event metadata and gap diagnostics. These logs preserve source stream identities and sequence numbers; they are not lossless records or a globally ordered replay log. Do not log raw media or credentials.

Runtime boundaries

Host starts outputs before Engine and inputs. Detaching a session releases its adapters; Host policy decides when its execution ends. Shared inference closes only after execution children settle, and InferenceRuntime remains the sole owner of its runner processes. Ctrl+C/SIGTERM request orderly shutdown; repeated Ctrl+C does not abandon cleanup.

Audio sessions use playback-driven captions through TranscriptSynchronizationProcessor. PCM streams at the provider's native pace; caption publication and network sending do not pace audio capture. PCM-only providers use estimated word timing, corrected by measured audio duration. LiveKit playback feedback measures the local audio queue, not remote speakers.

The health endpoints are /live, /ready and /status; restrict their network exposure. Execution supervision requires POSIX. Process groups are not complete descendant sandboxes; deployments that need containment of detached browsers require an external cgroup/container. One attachment per execution is supported. Reattachment, persistent execution recovery and sleep/wake are not implemented. Control loss finishes affected jobs before re-registration; it does not replay model or tool work. Disconnecting does not delete the room.

More information

Deployment · Development · Avatar workspace · Model cache · Character setup

Metadata

Release files for alpha-avatar-host 0.6.8

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

Source distribution (sdist)

Source distribution for alpha-avatar-host 0.6.8
File Size Uploaded Provenance
alpha_avatar_host-0.6.8.tar.gz 49.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for alpha-avatar-host 0.6.8
File Interpreter ABI Platform
alpha_avatar_host-0.6.8-py3-none-any.whl Python 3 none any Details

Total release size: 135.4 kB

Release files / alpha_avatar_host-0.6.8.tar.gz

Download URL alpha_avatar_host-0.6.8.tar.gz
Size 49.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f98599f43f29bb752758651fd26b560dda449e27e2ad84d555a3c56bb25babe6
BLAKE2b-256 checksum
How to use checksums
2a972308bf120257b7d6e4d84e10c19d87253c07d9d4bffc94cdd569372e4b72
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / alpha_avatar_host-0.6.8-py3-none-any.whl

Download URL alpha_avatar_host-0.6.8-py3-none-any.whl
Size 85.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
64180a233f21a26c1911eeb4fff07c2c2cf4a71d9c498a3bef2f3adabc8e504c
BLAKE2b-256 checksum
How to use checksums
cecf6212165f731902b97c11622d04ee95ed3fed03e3d8d23f23efd1fd2d06a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for alpha-avatar-host 0.6.8

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.6.8 This release

2 release files No provenance

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