Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Ballet
Ballet

Getting started

  • Getting started
    • Quickstart
    • Your first real project

User guide

  • User guide
    • Organizations and projects
    • Planning with the planner
    • Tickets and the board
    • Sessions and questions
    • The night shift
    • Pipelines and skills
    • Users and access

Concepts

  • Concepts
    • Vision
    • Domain Model
    • Workflow
    • Ticket Pipeline
    • Questions and Human Involvement
    • Unattended Operation
    • Scheduling
    • Knowledge
    • Feature map
    • Skills
    • Ballet and the alternatives

Architecture

  • Architecture
    • Architecture Overview
    • Components
    • Data
    • Security
    • Observability
    • APIs and Protocols
    • Architecture Decisions
      • ADR-0001: Sphinx and reStructuredText for Project Documentation
      • ADR-0002: Go Services and a Svelte Web UI
      • ADR-0003: Orchestrate Existing Coding Agents Through Runtime Adapters
      • ADR-0004: Tenancy Model — Organization, Customer, Project
      • ADR-0005: Knowledge as a Separate Service with an MCP Interface
      • ADR-0006: OIDC Claims-Based RBAC for Humans, Scoped Run Tokens for Agents
      • ADR-0007: Code Review on Git Platforms via Forge Adapters
      • ADR-0008: Configurable Review and Merge Policy per Ticket
      • ADR-0009: Devcontainer per Run on Docker or Podman
      • ADR-0010: Central Skill Registry
      • ADR-0011: LLM Gateway for Credentials and Usage Metering
      • ADR-0012: PostgreSQL for Core and Knowledge
      • ADR-0013: Planner Runs as a Containerized Agent
      • ADR-0014: Separate Agent Session per Pipeline Stage
      • ADR-0015: Question Escalation Through the Planner
      • ADR-0016: Durable Orchestration in the Database
      • ADR-0017: Pipelines Defined per Project
      • ADR-0018: REST for Stateless, WebSocket + JSON-RPC + MessagePack for Stateful
      • ADR-0019: SQLite First, rqlite Later
      • ADR-0020: Planner Runs In-Process in Core
      • ADR-0021: Hybrid Vector Search over All Content
      • ADR-0022: Humans Reach Knowledge Through Core
      • ADR-0023: Process Backend for Development
      • ADR-0024: Authentication Off by Default for a Single Local User
      • ADR-0025: Agent Fleet Runs Sessions as Processes
      • ADR-0026: Interactive Sessions That Park When Idle
      • ADR-0027: Tenancy Model — Platform, Organization, Project
      • ADR-0028: The Feature Map — Features as a Versioned Graph in Core

How-to

  • How-to Guides
    • Run Ballet locally
    • Install Ballet on one host
    • Build an agent pool from a devcontainer
    • Run Ballet on Ballet
    • Configure OIDC Authentication

Reference

  • Reference
    • Configuration
    • REST API
    • Realtime API
    • Planner
    • Pipelines
    • Agents
    • LLM Gateway
    • Metrics
    • Knowledge MCP
    • Tracker MCP
    • Run Tokens

Development

  • Development
    • Code Layout
    • Persistence
    • Changing the REST API
    • Web UI Development
    • Website and documentation publishing
Back to top
View this page

Reference¶

Exact, exhaustive descriptions of configuration and interfaces.

  • Configuration
  • REST API
  • Realtime API
  • Planner
  • Pipelines
  • Agents
  • LLM Gateway
  • Metrics
  • Knowledge MCP
  • Tracker MCP
  • Run Tokens
Next
Configuration
Previous
Configure OIDC Authentication
Copyright © 2026, Ballet contributors
Made with Sphinx and @pradyunsg's Furo