Skip to main content
Advanced: ordinary named LiveKit agents should use chert dev. Use this optional mode when you want the connector to create a LiveKit room, dispatch your agent, and clean up the call’s resources. chert create-room starts a long-running connector; it creates a room when a call arrives, not at startup.
This private-preview adapter requires a qualified agent integration. An arbitrary LiveKit agent or an existing webhook URL is not enough. For application-owned sessions, use the Custom BYOR callbacks.

Before you start

  • Complete manual connector enrollment for create-room mode; use Node 22.12+ (22.x), 24.x or 26.x on macOS or Linux with durable local storage.
  • Run a named LiveKit agent with a verified chert-adapter-v1 health/cancellation hook on the same host, listening on literal loopback (127.0.0.1).
  • Obtain the exact agent name, deployment identifier, boot identifier, LiveKit URL, and hook port from that integration.
  • Supply LIVEKIT_API_KEY, LIVEKIT_API_SECRET, and CHERT_HOOK_SECRET securely to the connector process. Do not put secret values in command arguments or source control.

1. Install and initialize

Install the published package in your application:
Replace the uppercase placeholders with your integration’s values:
Use fresh config and state paths. The CLI does not start your agent or install its hook.

2. Check the integration

Start your agent, then run:
This checks the configuration and adapter health without allocating a room. Exit 3 currently means partial diagnostics; inspect the results before proceeding. Process liveness alone does not establish per-call readiness.

3. Enroll and start

Follow Manual connector enrollment, using chert-room.json as the base config and a fresh output config such as chert-room.enrolled.json. Use create-room instead of byor when starting the connector:
After activation, an incoming call triggers room creation and named dispatch. The adapter waits for the expected agent to become ready before accepting. Test inbound audio with Chert and verify cleanup after hangup.

Current limits

Preparation must finish within the supplied call deadline; the adapter enforces a maximum 60-second resource lifetime, with one active call at a time. This adapter supports audio only; that restriction does not apply to chert dev or chert byor, which support audio and video. Use BYOR for application-managed session lifetimes; changing modes requires a fresh config, state directory, and enrollment.