> For the complete documentation index, see [llms.txt](https://docs.halfred.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.halfred.ai/readme.md).

# Welcome to Halfred Documentation

![Halfred, at your service](/files/05o2TXDqmiUf5rHVWp58)

## What is Halfred?

Think the precision of HAL 9000 combined with the loyalty and quiet brilliance of Alfred, Bruce Wayne's best wingman. Behind the character is a real service: an AI infrastructure layer that serves the best model for the job, with zero friction.

Halfred is not a chatbot. It's the infrastructure that handles:

* **Intelligent model routing**: Automatically selects the best model for your use case
* **Multi-provider access**: Connect to OpenAI, Anthropic, Google, Mistral, and more through a single API
* **Profile-based abstraction**: Choose a profile (Lite, Standard, DeepThink) instead of managing individual models
* **Usage tracking**: Monitor consumption and credits in real-time
* **Unified billing**: One account, one invoice, even if requests hit multiple providers

## Why Choose Halfred?

### For Developers Who Want to Ship Fast

* **5-minute integration**: Simple SDK with minimal setup
* **No AI expertise required**: Choose a profile, we handle the rest
* **Drop-in OpenAI replacement**: Use existing OpenAI SDK code with Halfred
* **Zero vendor lock-in**: Switch providers seamlessly behind the scenes

### Intelligent and Cost-Effective

* **Smart routing**: Optimized for speed, quality, and cost
* **Resilient & reliable**: No interruption—requests auto-failover to maintain service and uptime
* **Transparent pricing**: Prepaid credit system with no hidden costs
* **Free development tier**: Test and prototype without consuming credits

## Quick Links

### Getting Started

* [Quick Start Guide](/01-getting-started/01-quickstart.md) - Get up and running in 5 minutes
* [Authentication](/01-getting-started/02-authentication.md) - How to create and manage API keys

### SDK Integration

* [Halfred Node.js SDK](/02-sdk-integration/01-nodejs.md) - Official Node.js/TypeScript SDK
* [Halfred Python SDK](/02-sdk-integration/02-python.md) - Official Python SDK
* [OpenAI SDK Compatibility](/02-sdk-integration/03-openai-compatibility.md) - Use Halfred with OpenAI clients

### Core Concepts

* [Model Profiles](/03-concepts/01-profiles.md) - Understanding Lite, Standard, DeepThink, and Dev profiles
* [Pricing & Credits](/03-concepts/02-pricing.md) - How credits and billing work
* [Tokens Explained](/03-concepts/03-tokens.md) - What tokens are and why they matter

### API Reference

* [REST API Documentation](/04-api-reference/01-endpoints.md) - Complete REST API reference
* [Error Handling](/04-api-reference/02-errors.md) - Error codes and troubleshooting

## Need Help?

* **Email**: <support@halfred.ai>
* **Discord**: [Join our community](https://discord.gg/wS2awX4EV7)
* **Dashboard**: [halfred.ai](https://halfred.ai)

***

Ready to get started? Follow our [Quick Start Guide](/01-getting-started/01-quickstart.md) to integrate Halfred in less than 5 minutes.