Welcome to cascadeflow documentation! 🌊
- Quickstart - Get started with cascadeflow in 5 minutes
- Providers - Configure and use different AI providers (OpenAI, Anthropic, Groq, Ollama, etc.)
- Presets - Use built-in presets for common use cases
- Streaming - Stream responses from cascade agents
- Tools - Function calling and tool usage with cascades
- Cost Tracking - Track and analyze API costs across queries
- Production Guide - Best practices for production deployments
- Performance Guide - Optimize cascade performance and latency
- FastAPI Integration - Integrate cascadeflow with FastAPI applications
- Custom Cascades - Build custom cascade strategies
- Custom Validation - Implement custom quality validators
- Edge Device Deployment - Deploy cascades on edge devices (Jetson, etc.)
- Browser/Edge Runtime - Run cascades in browser or edge environments
- n8n Integration - Use cascadeflow in n8n workflows
Comprehensive working code samples:
Python Examples: examples/
- Basic usage, preset usage, multi-provider
- Tool execution, streaming, cost tracking
- Production patterns, FastAPI integration
- Edge device deployment, vLLM integration
- Custom cascades and validation
TypeScript Examples: packages/core/examples/
- Basic usage, tool calling, multi-provider
- Streaming responses
- Production patterns
- Browser/Vercel Edge deployment
- 📖 GitHub Discussions - Q&A and community support
- 🐛 GitHub Issues - Bug reports and feature requests
- 📧 Email Support - Direct support
Comprehensive API documentation for all classes and methods:
- API Overview - Complete API reference for Python and TypeScript
- Python API
- CascadeAgent - Main agent class
- ModelConfig - Model and cascade configuration
- CascadeResult - Result object with 30+ diagnostic fields
- TypeScript API
- See TypeScript Package for API documentation
See also: Comprehensive examples in /examples directory
For contributors and advanced users:
- Architecture Guide - Detailed architecture, data flow, and code organization
- Contributing Guide - How to contribute to cascadeflow
The architecture guide covers:
- Directory structure (monorepo layout)
- Core components and design patterns
- Data flow and execution paths
- Adding new providers, quality checks, and routing strategies
- Testing strategy and development workflow