Skip to main content

​
Get Started

1

Prerequisites

  • Python 3.13+
  • PostgreSQL (local or managed)
  • Docker & Docker Compose (optional)
2

Install dependencies

uv sync
3

Configure environment

Copy and edit an env file (see .env.development, .env.staging, .env.production). Critical keys: LLM_API_KEY, JWT_SECRET_KEY, POSTGRES_*, optional MCP bases.
4

Run the API

make dev
# or: uvicorn app.main:app --host 0.0.0.0 --port 8000
Swagger UI: http://localhost:8000/docs | Metrics: /metrics

​
Authentication & Sessions

curl -X POST http://localhost:8000/api/v1/auth/register \
  -H 'Content-Type: application/json' \
  -d '{"email":"you@example.com","password":"StrongP@ssw0rd"}'

​
Rate Limiting & CORS

  • Rate limiting via SlowAPI; defaults configurable in app/core/config.py (e.g., RATE_LIMIT_ENDPOINTS).
  • CORS configured in app/main.py from ALLOWED_ORIGINS env var.