Unmute and unmute-core
- Unmute is a compiler. You describe an agent in
agent.yaml, and Unmute writes a Python project for LiveKit or Pipecat. - unmute-core is the library that project imports. It runs the call: it saves values, steps through tasks, runs tools and sends spans.
- Your own agent can import the same library. You build the pipeline in
your
agent.py, and call the library where you need it. - The library never reads
agent.yamland never builds the pipeline. The framework still owns speech, turn detection and the model plugins.
agent.yaml key turns into which class.
Plug points
Four interfaces let your code add a capability without changing the library.
A plug point may add a capability. It never changes how the rest of the
library behaves.
How to read these docs
- Quickstart. Run the smallest agent in a few minutes.
- Build a salon agent. Grow one agent, one piece per page. Each page says what the piece is, why it is there, and how to use it.
- On your framework. Already have a LiveKit or Pipecat agent? Add one piece at a time.
- Guides. One section per topic, such as State or Tasks. Each starts with what the topic is and when to use it, then goes deeper one page at a time.
- Example agents. Four whole agents with a different shape of call each: a finder, a long intake, an outbound reminder and a bilingual tutor. Each runs on both frameworks.
- Reference. Every argument of every class, such as the Tasks reference.
Where to go next
Quickstart
Run the smallest agent on LiveKit or Pipecat.
Build a salon agent
Grow one agent, one piece per page.
Add one piece to your agent
Use only the parts you need on a plain agent.
How Unmute uses it
Which
agent.yaml key becomes which library class.Example agents
Four whole agents, each a different shape of call.
Type the path
Let the model understand, and let code decide and speak.