Skip to main content

Prerequisites

  • Docker (recommended) or Python 3.11+
  • An API key for your LLM provider (Anthropic, Bedrock, etc.)

Engine only

The stateless engine — no database, no widget. Good for embedding into your own backend.
1

Write your spec

Create agents.yml (see YAML Reference for all fields):
2

Generate plugin stubs

Creates the plugins/ folder with stubs for your tools and resolvers. Fill them in with your business logic.
3

Validate

Fully offline — no LLM calls, no network. Exits non-zero on any error.
4

Run

Call it:

With conversation history and widget

Adds persistent conversations, multi-turn sessions, SSE streaming, and an embeddable chat widget.
1

Same agents.yml

No changes to your spec.
2

Run with widget mode

3

Embed the widget

Drop this into any HTML page — React, Vue, plain HTML, anything:
The widget handles sessions, streaming, and conversation history automatically.
See Widget for all attributes and framework integration guides.

Comparison


Local development (no Docker)