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 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 - Complete walkthrough from account creation to first API call

2. Authentication - 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

• Python: Halfred Python SDK

Option 2: OpenAI SDK Compatibility

• Use existing OpenAI SDK code with Halfred: OpenAI SDK Guide

• 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

Next Steps

After completing the quick start:

1. Learn about Model Profiles to choose the right profile for your use case

2. Understand Pricing & Credits to manage costs effectively

3. Explore advanced features to optimize your integration

Need Help?

• Check our FAQ section

• Contact support at [email protected]

• Join our Discord community