Skip to main content

Install

Source on GitHub: unpod-ai/superdialog.
Install only the extras you need:

Step 1 - Generate a playbook from a prompt

superdialog generate is the default creation path. It writes a validated simple-format playbook - prose steps plus a persona - that runs on the Playbook engine.
The result is a human-readable, git-diffable YAML file you can edit by hand:
Prefer Python? from superdialog.playbook import generate_simple_playbook returns the same validated YAML from an async call.

Step 2 - Build the runtime agent

DialogMachine is the one entry point. Point it at your artifact and pick a model URI - it runs the Playbook engine by default.

Step 3 - Run a conversation

Or use the bundled CLI - no Python code needed:
The REPL runs on the Playbook engine and prints a per-turn status line ([checkpoint=<id> ended=<bool>]) so you can watch outcomes advance.

Step 4 - Add a tool

On the Playbook engine, tools live in the playbook’s process layer - HTTP or registered Python callables the Director runs off the speech path. For a quick local function, register it by id:
See Tools for declaring tools in the playbook, pipelines, and the legacy DialogMachine(tools=[...]) bridge.

Step 5 - Deploy anywhere

The same agent object drops into every host - the Agent protocol is the only contract:

LiveKit

Plug in as an Agent(llm=...) plugin - real token streaming

PipeCat

Drop in as a FrameProcessor in your pipeline

FastAPI

Mount a /turn endpoint for text chatbots

Unpod Voice

Connect via WebSocketRunner to Unpod infrastructure
Prefer a graph? The legacy path still works: superdialog flow generate "..." --output appointment.json writes a flow graph, and DialogMachine(Flow.load("appointment.json"), llm=..., engine="flow") runs the original graph engine. See Flows. By default a flow JSON runs compiled on the Playbook engine - no engine="flow" needed.

What’s next

Thinking in Playbooks

The checkpoint mental model

Playbooks

Author the simple and full formats

Architecture

Two engines, the Talker/Director runtime, and data flow

CLI Reference

All superdialog commands