Skip to main content

Introduction

Our RESTful, OpenAI-compatible API is designed to be simple, efficient, and developer-friendly. This guide will help you quickly understand how to start integrating our services into your applications using standard HTTP conventions.

API Requests

Our API uses only the two most common HTTP methods:
  • GET: Retrieve data from the server
  • POST: Send data to the server
All requests should include these headers:
  • Content-Type: application/json
  • Authorization: Bearer {api_key}
Interacting with the API requires a Bearer token:
You can generate API keys from here. Tokens are tied to your organization.
All responses are JSON. Sample response:
All responses also include meaningful HTTP status codes (200, 400, 403, 429).
We enforce limits per organization and API key. Exceeding the limit returns a 429 Too Many Requests response. Rate limits reset automatically after a short cooldown.

Playground

Experiment with API calls directly in your browser.

SDK Integrations

Connect Halesis to the AI SDKs and tooling you already use.