Quick Start | PraisonAIUI Docs

Health Endpoints Guide
PraisonAIUI
Testing
Api
CLI API Reference
Component API Reference
Features REST API Reference
Health API Reference
Python SDK API
Sessions API Reference
API Testing Guide
TypeScript SDK Reference
Concepts
Architecture: AG-UI Protocol vs Gateway Integration
YAML Configuration
Providers
Slots & Components
Templates & Layouts
Examples
Advanced Examples
Basic Examples
Features
A2UI canvas — agent-driven UI
Agent UI host — modular dashboard shell
Chat Attachments
Backend Integration Contract
Browser Automation
Channel-to-Chat Bridge
Code Execution
Feature Comparison: PraisonAIUI vs OpenClaw
Config Hot-Reload
Content Sources
How the UI Looks Are Built
Dark Mode
Dashboard
Deployment Guide
Device Pairing
What Makes PraisonAIUI Different
Feature Inventory
Gap Analysis — Validated Against praisonai SDK
Gateway Chat
Hot Reload
How to Add a Feature to PraisonAIUI
Internationalization (i18n)
Image Preview in Chat
AIUI Integration — Critical Review & Architecture Analysis
Knowledge Embedding Model Configuration
Plugin Marketplace
Media Analysis
Message Elements
Model Fallback
Navigation
PraisonAI package integration
Protocol Architecture Reference
Protocol Versioning
Feature Protocols
Progressive Web App (PWA)
SEO
Session Management
Standalone vs Integrated
AIUI Standardization — Verification Report
Steps / Chain-of-Thought
UI Styles
Subagent Tree View
Theme System
Theming
Text-to-Speech (TTS)
Video Studio
Widget Zones
Getting Started
CLI Reference
Deploy to GitHub Pages
Installation
Quick Start
Protocols
Application Design Protocol (ADP) — Research Report
Application Design Protocol (ADP)
PraisonAIUI → ADP Field Mapping
ADP Implementation Status
Application Design Protocol (ADP) — Normative Specification
ADP Validation Rules
Typescript
Components
TypeScript SDK Overview
Next.js Adapter
Runtime

Quick StartGet a working AI dashboard in under 60 seconds.PrerequisitesPython 3.10+An OpenAI API key (or compatible provider)InstallOption 1: Dashboard Mode (recommended)Create an app.py:Run:Open http://localhost:8000 — your dashboard is live with chat, agent management, memory, sessions, and config pages.Option 2: YAML Chat ModeCreate a chat.yaml:Run:Option 3: Documentation ModeGenerate a static docs site from Markdown files:Next StepsCLI Reference — Full command reference with all 22 command groupsPython API — SDK function referenceDashboard Features — All 24 dashboard pagesConfiguration — YAML configuration guideDiagnosticsIf something isn't working: