> 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/01-getting-started.md).

# Getting Started

Get up and running with Halfred in less than 5 minutes. Complete guide from account creation to your first API call.

## What You'll Learn

* How to create a Halfred account and project
* How to generate and manage API keys
* How to make your first API call
* Basic authentication and security best practices

## Prerequisites

* A Halfred account (sign up at [halfred.ai](https://halfred.ai) with Google, GitHub, or email)
* Basic knowledge of REST APIs or your preferred programming language
* An HTTP client or SDK (we support Node.js, Python, and OpenAI-compatible SDKs)

## Quick Start Path

1. [**Quick Start Guide**](https://docs.halfred.ai/01-getting-started/01-quickstart.md) - Complete walkthrough from account creation to first API call
2. [**Authentication**](https://docs.halfred.ai/01-getting-started/02-authentication.md) - Learn about API keys, security, and best practices

## Choose Your Integration Method

Halfred offers multiple ways to integrate:

### Option 1: Halfred Native SDKs (Recommended)

* **Node.js/TypeScript**: [Halfred Node.js SDK](https://docs.halfred.ai/02-sdk-integration/01-nodejs.md)
* **Python**: [Halfred Python SDK](https://docs.halfred.ai/02-sdk-integration/02-python.md)

### Option 2: OpenAI SDK Compatibility

* Use existing OpenAI SDK code with Halfred: [OpenAI SDK Guide](https://docs.halfred.ai/02-sdk-integration/03-openai-compatibility.md)
* Works with OpenAI SDKs in any language (Go, PHP, Ruby, Java, .NET, etc.)

### Option 3: Direct REST API

* Make direct HTTP calls: [REST API Reference](https://docs.halfred.ai/04-api-reference/01-endpoints.md)

## Next Steps

After completing the quick start:

1. Learn about [Model Profiles](https://docs.halfred.ai/03-concepts/01-profiles.md) to choose the right profile for your use case
2. Understand [Pricing & Credits](https://docs.halfred.ai/03-concepts/02-pricing.md) to manage costs effectively
3. Explore [advanced features](https://docs.halfred.ai/05-advanced/01-best-practices.md) to optimize your integration

## Need Help?

* Check our [FAQ section](https://halfred.ai/#faq)
* Contact support at <support@halfred.ai>
* Join our [Discord community](https://discord.gg/wS2awX4EV7)
