> ## Documentation Index
> Fetch the complete documentation index at: https://www.getmaxim.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Bifrost Overview

> 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](/bifrost/quickstart/go-package)         |
| **HTTP Transport** | Language-agnostic, microservices    | 30 seconds | [📖 HTTP Transport Guide](/bifrost/quickstart/http-transport) |

## I Want To...

| Task                            | Go Here                                                                            |
| ------------------------------- | ---------------------------------------------------------------------------------- |
| **Replace my OpenAI SDK calls** | [OpenAI Integration](/bifrost/usage/http-transport/integrations/openai-compatible) |
| **Use Bifrost in my Go app**    | [Go Package Usage](/bifrost/usage/go-package/overview)                             |
| **Configure via HTTP/JSON**     | [HTTP Transport Usage](/bifrost/usage/http-transport/configuration/plugins)        |
| **Add fallback providers**      | [Providers](/bifrost/usage/providers)                                              |
| **Understand the architecture** | [Architecture](/bifrost/architecture/overview)                                     |
| **See practical examples**      | [Examples](https://github.com/maximhq/bifrost)                                     |
| **Deploy to production**        | [Production Guide](/bifrost/usage/http-transport/configuration/providers)          |
| **Contribute to the project**   | [Contributing](/bifrost/contributing/overview)                                     |

## Documentation Sections

### Quick Start

Get running in under 30 seconds with step-by-step guides for both Go package and HTTP transport usage.

### [Usage](/bifrost/usage/go-package/overview)

Complete API reference and usage guides:

* [**Go Package**](/bifrost/usage/go-package/overview) - Direct Go integration
* [**HTTP Transport**](/bifrost/usage/http-transport/configuration/providers) - REST API with drop-in integrations

### [Architecture](/bifrost/architecture/overview)

Deep dive into Bifrost's design, performance, and internals:

* System overview and request flow
* Performance benchmarks and optimization
* Plugin and MCP architecture

### [Examples](https://github.com/maximhq/bifrost)

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**](/bifrost/usage/providers) - Multi-provider support and advanced configurations
* [**Key Management**](/bifrost/usage/key-management) - API key rotation and distribution
* [**Memory Management**](/bifrost/usage/memory-management) - Performance optimization
* [**Networking**](/bifrost/usage/networking) - Proxies, timeouts, and retries
* [**Error Handling**](/bifrost/usage/errors) - Error types and troubleshooting

### [Contributing](/bifrost/contributing/overview)

Help improve Bifrost for everyone:

* Development setup and guidelines
* Adding new providers and plugins
* Documentation standards

### Additional Resources

* [**Benchmarks**](/bifrost/overview/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

* [**Migration Guide**](/bifrost/usage/http-transport/integrations/migration-guide) - Migrate from existing providers
* [**Benchmarks**](/bifrost/overview/benchmarks) - Performance benchmarks and optimization
* [**Production Deployment**](/bifrost/usage/http-transport/configuration/providers) - Scale to production