# Getting Started

## 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**](/01-getting-started/01-quickstart.md) - Complete walkthrough from account creation to first API call
2. [**Authentication**](/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](/02-sdk-integration/01-nodejs.md)
* **Python**: [Halfred Python SDK](/02-sdk-integration/02-python.md)

### Option 2: OpenAI SDK Compatibility

* Use existing OpenAI SDK code with Halfred: [OpenAI SDK Guide](/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](/04-api-reference/01-endpoints.md)

## Next Steps

After completing the quick start:

1. Learn about [Model Profiles](/03-concepts/01-profiles.md) to choose the right profile for your use case
2. Understand [Pricing & Credits](/03-concepts/02-pricing.md) to manage costs effectively
3. Explore [advanced features](/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)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.halfred.ai/01-getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.