PraisonAI/examples/serve

PraisonAI Serve Examples

Examples for all PraisonAI server types and the unified endpoints CLI.

Examples

Example	Description	CLI Command
unified_server.py	All providers in one server	praisonai serve unified
agent_as_api_single.py	Single agent HTTP API	praisonai serve agents
agents_as_api_router.py	Multi-agent router API	praisonai serve agents
a2a_server_client.py	A2A protocol server	praisonai serve a2a
a2u_events_stream.py	A2U event stream	praisonai serve a2u
mcp_http_server.py	MCP HTTP server	praisonai serve mcp
tools_as_mcp_server.py	Tools as MCP server	praisonai serve tools
agent_launch_modes.py	Agent.launch() API	Python only
endpoints_unified_client.py	Unified client	praisonai endpoints
serve_example.py	Recipe server client	praisonai recipe serve

Server Commands

Command	Description
praisonai serve unified --port 8765	Start unified server
praisonai serve agents --file agents.yaml --port 8000	Start agents API
praisonai serve recipe --port 8765	Start recipe server
praisonai mcp serve --transport http-stream --port 8080	Start MCP server
praisonai serve tools --port 8081	Start tools MCP server
praisonai serve a2a --port 8082	Start A2A server
praisonai serve a2u --port 8083	Start A2U server

Client Commands

Command	Description
praisonai endpoints list	List all endpoints
praisonai endpoints list --type agents-api	Filter by type
praisonai endpoints describe <name>	Get endpoint details
praisonai endpoints invoke <name> --input-json '{}'	Invoke endpoint
praisonai endpoints health	Check server health
praisonai endpoints types	List provider types
praisonai endpoints discovery	Show discovery document

Quick Start

# Terminal 1: Start unified server
export OPENAI_API_KEY=your-key
praisonai serve unified --port 8765

# Terminal 2: Use endpoints CLI
praisonai endpoints health
praisonai endpoints list
praisonai endpoints types

Provider Types

Type	Description
recipe	Recipe runner endpoints
agents-api	Single/multi-agent HTTP API
mcp	MCP server (stdio, http, sse)
tools-mcp	Tools exposed as MCP server
a2a	Agent-to-agent protocol
a2u	Agent-to-user event stream

Configuration Options

Option	Description	Default
host	Server bind address	127.0.0.1
port	Server port	8765
auth	Auth type (none, api-key, jwt)	none
api_key	API key for auth	-
preload	Preload recipes on startup	false
recipes	List of recipes to serve	all
cors_origins	CORS allowed origins	-

Advanced Features

Feature	CLI Flag	Description	Docs
Rate Limiting	--rate_limit 100	Requests per minute per client	Code CLI
Request Size Limit	--max_request_size 10485760	Max request body (bytes)	Code CLI
Metrics Endpoint	--enable_metrics	Prometheus /metrics endpoint	Code CLI
Admin Reload	--enable_admin	Hot reload /admin/reload	Code CLI
Workers	--workers 4	Multi-process workers	Code CLI
OpenTelemetry	--trace_exporter otlp	Distributed tracing	Code CLI
OpenAPI	GET /openapi.json	API specification	Code CLI

Advanced Examples

Example	Description
recipe_serve_features.py	All advanced features demo

Advanced CLI Commands

# Production server with all features
praisonai recipe serve \
  --host 0.0.0.0 \
  --port 8765 \
  --auth api-key \
  --workers 4 \
  --rate_limit 100 \
  --enable_metrics \
  --enable_admin

# Get metrics
curl http://localhost:8765/metrics

# Get OpenAPI spec
curl http://localhost:8765/openapi.json

# Hot reload recipes
curl -X POST http://localhost:8765/admin/reload \
  -H "X-API-Key: your-key"

CLI Commands

# Health check
praisonai endpoints health

# List recipes (with auth)
praisonai endpoints list --api-key your-key

# Invoke recipe
praisonai endpoints invoke my-recipe \
  --input-json '{"query": "Hello"}' \
  --api-key your-key \
  --json

Security Notes

• Always use --auth api-key when binding to 0.0.0.0
• Store API keys in environment variables, not config files
• Use HTTPS in production (via reverse proxy)