Hades / Docs
Sign In Get API Key

Getting Started

Overview

The Hades API provides access to state-of-the-art language and image models through a simple, OpenAI-compatible interface. Get started in minutes.

Chat Completions

Generate text with Hades models using the familiar chat completions format.

Models

Access Hades-1.0, Hades-1.5, Hades-2.0 and more through a unified API.

Image Generation

Create stunning images with Hades-Image, our SOTA image generation model.

Streaming

Stream responses in real-time for interactive applications.

Base URL

HTTPShttps://api.hadexs.com/v1

All REST endpoints are rooted at /v1. Local dev servers may proxy through your app origin at /api/v1.

Available Models

Start with hades-1.0 on Free, then unlock hades-1.5 and hades-2.0 on paid plans. See the page for the full table.

Getting Help

Follow us on X and Instagram, open a ticket, or email support@hadexs.com / zunosagents@gmail.com.

Getting Started

Quickstart

Get up and running with the Hades API in under 2 minutes.

1
Sign up

hadexs.com

2
Create key

Dashboard → API Keys

3
Send request

Bearer hadexs_sk_...

Get your API key

Sign up and open Dashboard → API Keys. Copy the secret when shown — you can reveal saved keys later.

Make your first request

curl
curl https://api.hadexs.com/v1/chat/completions \
  -H "Authorization: Bearer hadexs_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "hades-1.0",
    "messages": [{"role": "user", "content": "Explain quantum computing in simple terms"}]
  }'

Use the Python SDK

Python
from openai import OpenAI

client = OpenAI(
    api_key="hadexs_sk_...",
    base_url="https://api.hadexs.com/v1",
)

completion = client.chat.completions.create(
    model="hades-1.0",
    messages=[{"role": "user", "content": "Hello!"}],
)
print(completion.choices[0].message.content)

Use with Node.js

JavaScript
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "hadexs_sk_...",
  baseURL: "https://api.hadexs.com/v1",
});

const response = await client.chat.completions.create({
  model: "hades-1.0",
  messages: [{ role: "user", content: "Hello!" }],
});
console.log(response.choices[0].message.content);

Getting Started

Authentication

All Hades API requests require authentication using an API key.

API Keys

Create keys in the dashboard. Each key begins with hadexs_sk_.

Request Headers

Header
Authorization: Bearer hadexs_sk_...

Security Best Practices

  • Never expose API keys in client-side browser code
  • Store keys in environment variables, not source code
  • Rotate keys immediately if compromised
  • Create separate keys per application or environment
  • Delete unused keys from your dashboard
Warning

API keys are only shown once when created. Store them securely before dismissing the creation dialog.

Getting Started

API Keys

Authenticate requests to the Hades API. Keys are encrypted at rest and can be revealed from the dashboard.

Create a key

Open Dashboard → API Keys and click Create API Key. Name keys by environment (Production, Staging, Local).

Reveal & rotate

Use the eye icon to reveal a saved key. Delete and recreate to rotate.

Dashboard

Manage keys, usage, and billing from the developer dashboard.

Getting Started

Rate Limits

Hades enforces rate limits per API key to ensure fair access for all users.

Limits by Tier

TierRequests / minTokens / minRequests / day
Free3014,40014,400
Pro10060,00086,400
EnterpriseUnlimitedUnlimitedUnlimited

Rate Limit Headers

HTTP
x-ratelimit-limit-requests: 30
x-ratelimit-limit-tokens: 14400
x-ratelimit-remaining-requests: 28
x-ratelimit-remaining-tokens: 13122
x-ratelimit-reset-requests: 2s
x-ratelimit-reset-tokens: 1s

Handling 429 Errors

Retry with exponential backoff or upgrade your plan for higher limits.

API Reference

Chat Completions

Generate text responses using the chat completions endpoint.

POST/v1/chat/completions

Request Body

ParameterTypeRequiredDescription
modelstringYesModel ID (see Models)
messagesarrayYesConversation messages
temperaturenumberNo0–2, default 1
max_tokensintegerNoMax tokens to generate
streambooleanNoEnable streaming

Example Request

curl https://api.hadexs.com/v1/chat/completions \
  -H "Authorization: Bearer hadexs_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "hades-1.0",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "What is 2 + 2?"}
    ],
    "temperature": 0.7,
    "max_tokens": 1024
  }'

Example Response

JSON
{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "model": "hades-1.0",
  "choices": [{
    "index": 0,
    "message": { "role": "assistant", "content": "2 + 2 equals 4." },
    "finish_reason": "stop"
  }],
  "usage": { "prompt_tokens": 24, "completion_tokens": 9, "total_tokens": 33 }
}

API Reference

Models

Hades provides access to a curated set of language, image, and audio models.

Language Models

Model IDPlanBest For
hades-1.0Free and upGeneral purpose, fast responses
hades-1.5Pro and upBalanced performance, longer reasoning
hades-2.0Plus and upMost capable, complex reasoning

Audio Models

Model IDTypePlan
hades-asrTranscriptionAll plans

List Models via API

curl
curl https://api.hadexs.com/v1/models \
  -H "Authorization: Bearer hadexs_sk_..."

API Reference

Streaming

Stream responses token-by-token using Server-Sent Events.

Enable streaming

Set stream: true on chat completion requests.

Python
stream = client.chat.completions.create(
  model="hades-1.0",
  messages=[{"role": "user", "content": "Tell me a story"}],
  stream=True,
)
for chunk in stream:
  if chunk.choices[0].delta.content:
    print(chunk.choices[0].delta.content, end="", flush=True)

Stream Format

Each SSE line is a JSON object with choices[0].delta.content fragments until [DONE].

API Reference

Image Generation

Generate images with Hades image models using the same API key.

Endpoint

POST/v1/images/generations

Request

Pass prompt, model (hades-image or tiered ids), and optional size.

Image models

hades-1.5 and hades-2.0 image tiers map to your plan. See Pricing for daily image allowances.

Guides

Function Calling

Pass tools and optional tool_choice on chat completions (OpenAI-compatible).

Tools parameter

Define JSON-schema functions the model may invoke; handle tool calls in your app loop.

Example

See OpenAI tool calling docs — Hades accepts the same request shape at /v1/chat/completions.

Guides

Errors

HTTP status codes

  • 401 — invalid or missing API key
  • 429 — rate limit exceeded
  • 500 — server error (retry with backoff)

Error shape

JSON
{ "error": { "message": "...", "type": "invalid_request_error", "code": "..." } }

Guides

Best Practices

Keys & security

Use server-side proxies; never ship hadexs_sk_ keys to browsers.

Retries

Retry idempotent requests on 429/5xx with jittered exponential backoff.

Production

Separate keys per service, monitor usage in the dashboard, and set wallet alerts before launch.

Zunos

Zunos CLI

Pro · Plus · Premium only — no free tier

Launch Zunos agents inside any terminal. zunos and hzunos are the same binary. Runs in your current project folder. Paid plan required to authenticate and execute tasks.

Guided walkthrough

From install to a completed task

Runs in your current project folder

The terminal is always the source of truth. Sign in with the Hadexs account that holds your Pro (or higher) subscription, then run agents against the folder you are in.

Terminal — zsh
# 1. Install the CLI
$ npm install --global https://hadexs.com/downloads/cli.tgz

# 2. Sign in with your Hades account
$ hzunos login you@email.com

# 3. Run a task from your project folder
$ hzunos run "Research the top 10 competitors and write a report"

→ connected to Hades · local execution enabled
✓ report saved to ./competitor-report.md

Step by step

The frames below show the normal path through the CLI.

01
Install

Install the first-party CLI

Terminal — zsh
$ npm install --global https://hadexs.com/downloads/cli.tgz
added zunos@0.1.0
$ hzunos --help
✓ hzunos is ready

Node.js 18+ required. Install from the Hadexs download route — not the public npm registry.

02
Authenticate

Connect your paid Hadexs account

Terminal — login
$ hzunos login you@email.com
→ Checking entitlement…
✓ Logged in as you@email.com — plan pro
$ hzunos whoami
  email   you@email.com
  plan    pro
  paid    true

Free accounts are rejected. Credentials stay local in ~/.zunos/config.json.

03
Choose

Pick an agent for the job

Terminal — agents
$ hzunos agents
  chief     Orchestrator
  coder     Engineering
  shell     Terminal operator
  research  Analyst
$ hzunos run --agent research "Summarize this repo"

Default agent is chief. Use --agent to pin coder, shell, or research.

04
Chat

Stay in an interactive shell

Terminal — REPL
$ hzunos shell --agent coder
chief › Explain package.json scripts
✓ reply streamed in this terminal
coder › exit

hzunos chat is an alias for a one-shot with the default agent. Type exit / quit to leave the REPL.

05
Complete

See each action and the saved result

Terminal — task complete
$ hzunos run "Write the competitor report to research/report.md"
✓ info — sources collected
✓ write_file — research/report.md
✓ task complete — 2 actions
  Saved inside the current workspace.

Paths stay relative to the directory where you started the command.

06
Recover

Understand a plan or auth failure

Terminal — task stopped
× Paid Zunos plan required (you@email.com)
→ hzunos status
  plan    free
  paid    false
· Open https://hadexs.com/pricing to upgrade

Check hzunos whoami, confirm the right email, then upgrade to Pro or higher.

Commands

Everything the binary understands. zunos works anywhere you type hzunos.

hzunos login [email]

Connect the Hadexs account that holds your paid plan. Saves a local credential.

hzunos logout

Removes the saved credential from ~/.zunos/config.json.

hzunos whoami

Show email, plan, and whether the account is paid. Alias: hzunos status.

hzunos agents

List built-in agents (chief, coder, shell, research).

hzunos run [--agent NAME] "task"

One-shot task in the current folder. Requires Pro or above.

hzunos chat "task"

Shortcut for run with your default agent.

hzunos shell [--agent NAME]

Interactive REPL. Leave with exit / quit or Ctrl+C. Alias: repl.

hzunos bridge

Probe the local Zunos Desktop bridge on port 8787.

hzunos config

Print local config path and non-secret settings.

hzunos config set-key gemini YOUR_KEY

Store a provider key locally for richer agent replies. Never printed by config.

hzunos config set-key glm YOUR_KEY

Optional GLM key. Keys stay on disk in your home config — not uploaded to Hadexs.

hzunos config set defaultAgent coder

Change the default agent used by chat / bare run.

hzunos ide

Print install steps for the VS Code / Cursor extension.

hzunos --help

Command help. Also: hzunos -v for version.

Agents

Orchestrator chief

Plans work, picks tools, and drives multi-step tasks in your project.

Engineering coder

Writes and reviews code, diffs, and refactors inside the working tree.

Terminal shell

Turns natural language into safe, approved shell commands.

Analyst research

Summarizes repos, docs, and context for decisions.

Plans & access

Pro and above only

The CLI checks entitlement on every agent command. Free and unsigned sessions cannot run tasks. Subscribe on Pricing, then hzunos login with that email.

  • Install once globally; re-run the npm install URL to update.
  • Prefer the project root as your cwd so relative paths stay predictable.
  • Pair with the IDE extension for Command Palette launches.
  • Desktop Mac app is separate — download from /download (also paid).

Resources

Changelog

Recent releases

API v1 chat, streaming, dashboard billing, and docs refresh — October 2026.

Resources

Status

Uptime

Live checks at hadexs.com/status. Incident updates post there first.

Resources

Support

Contact

Email support@hadexs.com or zunosagents@gmail.com. For Zunos agent workflows, see Zunos.