Skip to main content
from praisonaiagents import Agent

agent = Agent(name="code-recipe-agent", instructions="Execute code-based recipes.")
agent.start("Run the code-generation recipe to scaffold a new FastAPI project.")
The user hits the recipe server over HTTP; Python serve() config controls auth, CORS, and ports. Expose recipe workflows over HTTP — configure auth, CORS, and deployment from Python or YAML. 
from praisonai.recipe.serve import serve

serve(host="127.0.0.1", port=8765)

​
How It Works

​
Quick Start

1

Simple Usage

Start a local recipe server:
from praisonai.recipe.serve import serve

serve(host="127.0.0.1", port=8765)
Or via CLI:
praisonai recipe serve --host 127.0.0.1 --port 8765
2

With Configuration

Load settings from serve.yaml and override auth:
import os
from praisonai.recipe.serve import serve, load_config

config = load_config("serve.yaml")
config["auth"] = "api-key"
config["api_key"] = os.environ["PRAISONAI_API_KEY"]

serve(
    host=config.get("host", "127.0.0.1"),
    port=config.get("port", 8765),
    config=config,
)

​
How It Works

create_app() builds a Starlette ASGI application; serve() runs it with uvicorn. Configuration merges file, environment variables, and Python overrides — CLI flags take highest precedence.
RouteMethodDescription
/healthGETHealth check
/v1/recipesGETList recipes
/v1/recipes/{name}GETDescribe recipe
/v1/recipes/runPOSTRun recipe (sync)
/v1/recipes/streamPOSTRun recipe (SSE)

​
Configuration Options

KeyTypeDefaultDescription
hoststr"127.0.0.1"Bind address
portint8765Listen port
authstr"none"Auth mode (none, api-key, jwt)
api_keystrenvAPI key when auth=api-key
recipeslistallRecipe names to expose
preloadboolfalseWarm recipes on startup
cors_originsstr"*"Allowed CORS origins
log_levelstr"info"Server log level

​
serve.yaml example

host: 127.0.0.1
port: 8765
auth: api-key
recipes:
  - support-reply-drafter
  - meeting-action-items
preload: true
cors_origins: "https://app.example.com"
Set PRAISONAI_API_KEY in the environment instead of hardcoding keys.

​
Common Patterns

​
ASGI app for custom deployment

from praisonai.recipe.serve import create_app
import uvicorn

app = create_app(config={"auth": "none", "cors_origins": "*"})
uvicorn.run(app, host="0.0.0.0", port=8765)

​
Unified agents.yaml config

serve:
  host: 127.0.0.1
  port: 8765
  auth: api-key
  preload: true

from praisonai.recipe.serve import load_config, serve

config = load_config("agents.yaml").get("serve", {})
serve(host=config.get("host", "127.0.0.1"), port=config.get("port", 8765), config=config)

​
Test with TestClient

import os
from starlette.testclient import TestClient
from praisonai.recipe.serve import create_app

app = create_app(config={"auth": "api-key", "api_key": "test-key"})
client = TestClient(app)

assert client.get("/health").json()["status"] == "healthy"
assert client.get("/v1/recipes", headers={"X-API-Key": "test-key"}).status_code == 200

​
Best Practices

Set auth: api-key and load the key from PRAISONAI_API_KEY. Never expose an unauthenticated recipe server on a public network.
Set preload: true to warm recipes at startup and eliminate cold-start latency on the first request.
Set cors_origins to your exact frontend domain in production rather than "*".
Use the /health endpoint in Docker, Kubernetes, and load-balancer health checks.

Recipe Serve Advanced

Rate limiting, metrics, admin reload, and OpenTelemetry

Endpoints Code

Client-side code for calling recipe endpoints