مستندات HyperAPI

HyperAPI با APIهای OpenAI و Anthropic سازگار است؛ کد فعلی شما با تغییر آدرس پایه و کلید کار می‌کند.

شروع سریع

۱) ثبت‌نام کنید، ۲) از بخش شارژ موجودی حساب را افزایش دهید، ۳) در بخش «کلیدهای API» یک کلید بسازید. سپس در هر SDK سازگار با OpenAI فقط آدرس پایه و کلید را عوض کنید:

Base URL:  https://api.hyperapi.cloud/v1
API Key:   sk-hyper-...

احراز هویت

کلید را در هدر Authorization ارسال کنید. برای سازگاری با SDK آنتروپیک، هدر x-api-key هم پذیرفته می‌شود.

Authorization: Bearer sk-hyper-...

Chat Completions (سازگار با OpenAI)

curl https://api.hyperapi.cloud/v1/chat/completions \
  -H "Authorization: Bearer $HYPER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-6.1-sol",
    "messages": [{"role": "user", "content": "یک شعر کوتاه درباره‌ی تهران بنویس"}]
  }'
from openai import OpenAI

client = OpenAI(base_url="https://api.hyperapi.cloud/v1", api_key="sk-hyper-...")
resp = client.chat.completions.create(
    model="deepseek-v4.1-flash",
    messages=[{"role": "user", "content": "سلام!"}],
)
print(resp.choices[0].message.content)
import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.hyperapi.cloud/v1", apiKey: process.env.HYPER_API_KEY });
const r = await client.chat.completions.create({
  model: "claude-sonnet-5.5",
  messages: [{ role: "user", content: "Hello!" }],
});

استریم

با "stream": true پاسخ به‌صورت Server-Sent Events ارسال می‌شود. Tool calling، خروجی JSON ساختاریافته و پارامترهای reasoning بدون تغییر به مدل منتقل می‌شوند.

stream = client.chat.completions.create(model="gpt-6.1-sol", messages=[...], stream=True)
for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="")

Responses API

POST /v1/responses و همچنین GET /v1/responses/{id}، POST /v1/responses/{id}/cancel و DELETE /v1/responses/{id} پشتیبانی می‌شوند. هر پاسخ فقط برای حساب سازنده‌ی آن قابل دسترسی است.

resp = client.responses.create(model="gpt-6.1-sol", input="خلاصه‌ی این متن را بنویس: ...")
print(resp.output_text)

Messages API (سازگار با Anthropic) و Claude Code

import anthropic

client = anthropic.Anthropic(base_url="https://api.hyperapi.cloud", api_key="sk-hyper-...")
msg = client.messages.create(
    model="claude-opus-5.5",
    max_tokens=1024,
    messages=[{"role": "user", "content": "سلام"}],
)

برای Claude Code:

export ANTHROPIC_BASE_URL="https://api.hyperapi.cloud"
export ANTHROPIC_AUTH_TOKEN="sk-hyper-..."
export ANTHROPIC_MODEL="claude-sonnet-5.5"
claude

Cursor، Cline و سایر ابزارها

در تنظیمات «OpenAI Compatible» آدرس پایه را https://api.hyperapi.cloud/v1 و کلید را کلید HyperAPI خود قرار دهید و شناسه‌ی مدل را از فهرست مدل‌ها وارد کنید. LangChain، LlamaIndex، Vercel AI SDK و LiteLLM نیز به همین روش کار می‌کنند.

فهرست مدل‌ها

فهرست مدل‌ها همراه با قیمت (دلار به‌ازای یک میلیون توکن) از این آدرس قابل دریافت است و نیاز به کلید ندارد:

curl https://api.hyperapi.cloud/v1/models

صورت‌حساب و محدودیت‌ها

  • هزینه بر اساس توکن‌های ورودی و خروجی گزارش‌شده در فیلد usage محاسبه و بلافاصله از موجودی کسر می‌شود.
  • برای هر کلید می‌توانید سقف هزینه تعیین کنید؛ پس از رسیدن به سقف، درخواست‌ها با خطای ۴۰۲ رد می‌شوند.
  • سقف پیش‌فرض نرخ درخواست برای هر حساب در صفحه‌ی «حساب کاربری» کنسول نمایش داده می‌شود.

خطاها

خطاها با قالب استاندارد OpenAI برگردانده می‌شوند:

{"error": {"message": "...", "type": "insufficient_balance", "code": "insufficient_balance"}}
400invalid_requestبدنه‌ی درخواست نامعتبر است
401invalid_api_keyکلید ارسال نشده یا نامعتبر است
402insufficient_balance / key_spend_limit_reachedموجودی کافی نیست یا سقف کلید پر شده
404model_not_foundشناسه‌ی مدل اشتباه است
429rate_limit_exceededتعداد درخواست در دقیقه بیش از حد مجاز است (هدر Retry-After)
502 / 503service_unavailableاختلال موقت؛ چند ثانیه بعد دوباره تلاش کنید