Skip to main content
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 BYOR quickstart.

​
Before you start

  • Get the reviewed package and pilot access from Chert; use Node 22.23.2 or 24.14.0 on a POSIX host 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). Confirm compatibility with Chert first.
  • 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 tarball supplied by Chert 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 Connect your project, 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

The adapter has a four-second preparation budget and a 60-second resource lifetime, with one active call at a time. It supports audio only. Use BYOR for application-managed session lifetimes; changing modes requires a fresh config, state directory, and enrollment.