Overview
Bifrost Documentation
Welcome to Bifrost - the unified AI model gateway that provides seamless integration with multiple AI providers through a single API.
Quick Start
Choose your preferred way to use Bifrost:| Usage Mode | Best For | Setup Time | Documentation |
|---|---|---|---|
| Go Package | Direct integration, maximum control | 2 minutes | 📖 Go Package Guide |
| HTTP Transport | Language-agnostic, microservices | 30 seconds | 📖 HTTP Transport Guide |
I Want To…
| Task | Go Here |
|---|---|
| Get started in 30 seconds | Quick Start |
| Replace my OpenAI SDK calls | OpenAI Integration |
| Use Bifrost in my Go app | Go Package Usage |
| Configure via HTTP/JSON | HTTP Transport Usage |
| Add fallback providers | Providers |
| Understand the architecture | Architecture |
| See practical examples | Examples |
| Deploy to production | Production Guide |
| Contribute to the project | Contributing |
Documentation Sections
Quick Start
Get running in under 30 seconds with step-by-step guides for both Go package and HTTP transport usage.Usage
Complete API reference and usage guides:- Go Package - Direct Go integration
- HTTP Transport - REST API with drop-in integrations
Architecture
Deep dive into Bifrost’s design, performance, and internals:- System overview and request flow
- Performance benchmarks and optimization
- Plugin and MCP architecture
Examples
Practical, executable examples for common use cases:- End-to-end tool calling
- MCP integration scenarios
- Production deployment patterns
Core Concepts
Universal concepts that apply to both Go package and HTTP transport:- Providers - Multi-provider support and advanced configurations
- Key Management - API key rotation and distribution
- Memory Management - Performance optimization
- Networking - Proxies, timeouts, and retries
- Error Handling - Error types and troubleshooting
Contributing
Help improve Bifrost for everyone:- Development setup and guidelines
- Adding new providers and plugins
- Documentation standards
Additional Resources
- Benchmarks - Performance metrics and comparisons
What Makes Bifrost Special
- Unified API - One interface for OpenAI, Anthropic, Bedrock, and more
- Intelligent Fallbacks - Automatic failover between providers and models
- MCP Integration - Model Context Protocol for external tools
- Extensible Plugins - Custom middleware and request processing
- Drop-in Compatibility - Replace existing provider APIs without code changes
- Production Ready - Built for scale with comprehensive monitoring
Quick Links
- 30-Second Setup - Get started immediately
- Migration Guide - Migrate from existing providers
- Benchmarks - Performance benchmarks and optimization
- Production Deployment - Scale to production