README.md

Docs

Start here

• Python: README.md, then PYTHON_API_REFERENCE.md
• HTTP: SERVER.md, then INTEGRATION_GUIDE.md
• CLI: DEPLOYMENT_QUICKSTART.md

Quick reference

• QUICKREF.md - Providers, env vars, model formats

Examples

• ../examples/python_quickstart.py
• ../examples/python_budget_guardrails.py
• ../examples/chat_with_budget.py
• ../examples/rlm_with_context.py
• ../examples/rlm_context_optimization.py
• ../examples/research_with_exa.py
• ../examples/file_chatbot.py
• ../examples/file_researcher.py
• ../examples/run_metrics_demo.py
• ../examples/retry_tracking_demo.py
• ../examples/stress_testing_demo.py

Guides

• COOKBOOK.md - Practical patterns and recipes
• BACKGROUND_ORCHESTRATION.md - Worker patterns and pipelines
• FILE_BASED_CHATBOT.md - File-first chatbot flow
• FILE_BASED_RESEARCHER.md - File-first research flow
• RUN_METRICS.md - p95 cost/run and terminal state distributions
• STRESS_TESTING.md - Test p95 behavior under degraded conditions
• RLM_CONTEXT.md - RLM context management and optimization

Reference

• PYTHON_API_REFERENCE.md - Public Python API
• schema/bundle.json - JSON schema bundle
• schema/report.json - Report shapes

Project

• ../CHANGELOG.md - Release notes
• ../ROADMAP.md - Upcoming work