Unified Serve

Start any PraisonAI server with a single unified command

All PraisonAI servers are accessible through praisonai serve <type> – one command to start any server.

Quick Start

1. Start Agents Server

   praisonai serve agents --port 8000

2. Start Gateway Server

   praisonai serve gateway --port 8765

3. Start All-in-One Server

   praisonai serve unified --port 8765

All Serve Commands

Server Details

praisonai serve agents --file agents.yaml --port 8000

curl http://localhost:8000/

praisonai serve gateway --port 8765 --agents agents.yaml

const ws = new WebSocket('ws://localhost:8765');

praisonai serve mcp --transport sse --port 8080

praisonai serve recipe --port 8765 --reload

praisonai serve unified --port 8765

Authentication

Set --api-key to require a key on every request. Send it with either header.

# Start with a key
praisonai serve agents --api-key $API_KEY --host 0.0.0.0

# Authorization header
curl -H "Authorization: Bearer $API_KEY" http://localhost:8000/agents

# X-API-Key header
curl -H "X-API-Key: $API_KEY" http://localhost:8000/agents

Both headers are equivalent and use constant-time comparison. Missing or wrong keys return 401 {"error": "Unauthorized"}.

These paths stay public even when --api-key is set:

How It Works

Common Patterns

praisonai serve agents --reload --port 8000

praisonai serve agents --api-key $API_KEY --host 0.0.0.0

# Terminal 1: Agents API
praisonai serve agents --port 8000

# Terminal 2: Gateway
praisonai serve gateway --port 8765

# Terminal 3: MCP
praisonai serve mcp --transport sse --port 8080

praisonai serve unified --port 8765 --reload

Discovery Endpoint

All HTTP servers expose /__praisonai__/discovery for endpoint discovery.

curl http://localhost:8000/__praisonai__/discovery

{
  "server_name": "praisonai-agents",
  "version": "1.0.0",
  "providers": [...],
  "endpoints": [...]
}

Best Practices

Related