Quickstart

API 文档

HAPI 提供 OpenAI 兼容接口。保留现有 SDK 和请求结构,只需替换 Base URL 与 API Key。

OpenAI SDK 兼容 HTTPS / JSON

Base URL 与鉴权

所有请求都使用控制台生成的 API Key。请把密钥放在服务端环境变量中,不要写入网页或公开仓库。

BASE URLhttp://localhost:8080/v1

请求头

HTTP Header
Authorization: Bearer $HAPI_API_KEY
Content-Type: application/json

使用 cURL

下面的请求会调用 Chat Completions 接口并返回一条普通文本响应。

cURL
curl http://localhost:8080/v1/chat/completions \
  -H "Authorization: Bearer $HAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [{"role": "user", "content": "你好"}]
  }'

使用 Python

安装官方 OpenAI SDK:pip install openai

Python
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["HAPI_API_KEY"],
    base_url="http://localhost:8080/v1",
)

response = client.chat.completions.create(
    model="gpt-5.4-mini",
    messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)

使用 Node.js

安装官方 SDK:npm install openai

Node.js
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.HAPI_API_KEY,
  baseURL: "http://localhost:8080/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-5.4-mini",
  messages: [{ role: "user", content: "你好" }],
});

console.log(response.choices[0].message.content);

模型与常见错误

可用模型和实时价格以 模型广场 为准。请求失败时,优先根据 HTTP 状态码排查。

  • 401API Key 缺失、无效或已被禁用。
  • 400 / 404请求格式不正确,或模型名称不可用。
  • 429请求频率或并发超过当前账户限制。
  • 5xx上游模型暂时不可用,请稍后重试或切换模型。