Production

The agentflow api command starts a FastAPI + Uvicorn server that exposes your compiled graph as a fully-featured REST + WebSocket API. This section is the single source of truth for everything you need to run AgentFlow in production.

What the server exposes

Group	Prefix	What it does
Health	/ping	Unauthenticated health check
Graph	/v1/graph/...	Invoke, stream, stop, fix, inspect the graph
Threads	/v1/threads/...	CRUD for thread state and messages (requires checkpointer)
Store	/v1/store/...	Semantic memory CRUD and search (requires store backend)
Files	/v1/files/...	Multimodal file upload and retrieval
Config	/v1/config/...	Read server configuration (e.g. multimodal settings)

Full endpoint reference: API Reference

Configuration

All server behavior is controlled by two inputs:

1. agentflow.json — which graph to load, which auth backend, which checkpointer, rate limiting, etc. Complete reference: agentflow.json config
2. Environment variables — secrets and runtime tunables (JWT_SECRET_KEY, ORIGINS, MODE, LOG_LEVEL, etc.). Complete reference: Environment variables

Authentication and authorization

All endpoints except /ping pass through an auth + authorization layer:

• No auth ("auth": null) — all requests are allowed without credentials. Safe for internal networks or local dev.
• JWT ("auth": "jwt") — Bearer token checked against JWT_SECRET_KEY. Standard stateless auth.
• Custom ("auth": {"method": "custom", "path": "..."}) — subclass BaseAuth for any identity provider.
• Authorization ("authorization": "module:Class") — subclass AuthorizationBackend for per-resource RBAC.

Guide: Auth and Authorization

Rate limiting

Configured under the rate_limit key in agentflow.json. Three backends: memory (dev), redis (production), custom.

Guide: Rate limiting

Checkpointing

Thread state persistence. Without a checkpointer, every request is stateless. With PgCheckpointer, state survives across restarts and can be shared across multiple server instances.

Guide: Checkpointing

Deployment

For Dockerfile generation run agentflow build. For multi-worker, Kubernetes, and reverse-proxy deployments see the Deployment guide.

Quick start

pip install 10xscale-agentflow-cli
agentflow init          # scaffold a project
cp .env.example .env    # fill in API keys
agentflow api           # start the server

Access:

• API: http://127.0.0.1:8000
• Swagger: http://127.0.0.1:8000/docs
• ReDoc: http://127.0.0.1:8000/redocs
• Health: http://127.0.0.1:8000/ping