Usage
Usage Documentation
Complete API reference and usage guides for both Go package and HTTP transport integration methods.
Choose Your Integration Method
| Method | Description | Best For | Documentation |
|---|---|---|---|
| 🔧 Go Package | Direct Go integration | Go applications, custom logic | Complete Go API reference |
| 🌐 HTTP Transport | REST API with drop-in compatibility | Any language, microservices | HTTP endpoints and integrations |
🔧 Go Package Usage
Direct integration for Go applicationsCore Topics
- 📋 Overview - Getting started with the Go package
- 🎯 Bifrost Client - Main client methods and configuration
- 👤 Account Management - API key management and authentication
- 🔌 Plugins - Custom middleware and request processing
- 🛠️ MCP Integration - Model Context Protocol usage
- 📝 Logging - Logging configuration and best practices
- 📊 Schemas - Data structures and interfaces
Quick Links
- ⚡ Quick Start - 30-second setup
- 🏛️ Architecture - How it works internally
🌐 HTTP Transport Usage
REST API with drop-in compatibility for existing provider SDKsCore Topics
- 📋 Overview - Getting started with HTTP transport
- 🎯 Endpoints - Native Bifrost REST API
- 🔧 Configuration - JSON configuration for providers, plugins, and MCP
- 🔄 Integrations - Drop-in replacements for OpenAI, Anthropic, GenAI
Configuration
- 🔗 Providers - Provider setup and configuration
- 🛠️ MCP - Model Context Protocol configuration
- 🔌 Plugins - Plugin configuration and custom plugins
Drop-in Integrations
- 🤖 OpenAI Compatible - Replace OpenAI API calls
- 🧠 Anthropic Compatible - Replace Anthropic API calls
- 🔍 GenAI Compatible - Replace Google GenAI API calls
- 🔄 Migration Guide - Step-by-step migration from existing providers
🔧 Universal Concepts
These concepts apply to both Go package and HTTP transport usage:| Concept | Description | Documentation |
|---|---|---|
| 🔗 Providers | Multi-provider support and advanced configurations | Provider-specific settings, fallbacks, load balancing |
| 🔑 Key Management | API key rotation and weighted distribution | Key rotation strategies, security best practices |
| ⚡ Memory Management | Performance optimization and resource management | Memory usage patterns, optimization techniques |
| 🌐 Networking | Proxies, timeouts, retries, and connection management | Network configuration, proxy settings, retry policies |
| ❌ Error Handling | Error types, codes, and troubleshooting | Comprehensive error reference and resolution guide |
🚀 Getting Started
Migrating from Another Provider?
- 🔄 Migration Guide - Step-by-step migration
- 🤖 OpenAI Users - Drop-in replacement
- 🧠 Anthropic Users - Drop-in replacement
Need Advanced Features?
- 🔌 Plugins - Custom middleware
- 🛠️ MCP Integration - External tools
- 🏛️ Architecture - Understand internals