开发者文档

五分钟完成第一次调用

OpenAI 兼容接口、Claude 原生格式、流式输出、错误码与常用工具配置。

快速开始

QyanHub 兼容 OpenAI API。已有代码只需要改两处:base_url 和 API Key。

  • 在控制台注册并充值。
  • 在「API 密钥」页面创建一个 Key。
  • 把 base_url 设为下面的地址,模型名从模型页复制。
Base URL
https://api.qyanhub.ai/v1
认证方式
Authorization: Bearer sk-...
模型命名
厂商/模型,如 anthropic/claude-sonnet-5.5
from openai import OpenAI

client = OpenAI(base_url="https://api.qyanhub.ai/v1", api_key="sk-...")

resp = client.chat.completions.create(
    model="openai/gpt-6.1-sol",
    messages=[{"role": "user", "content": "用一句话介绍你自己"}],
)
print(resp.choices[0].message.content)

认证与 API Key

每个请求都在请求头里带上 API Key。Key 只在创建时完整显示一次,请保存在环境变量或密钥管理服务里,不要写进前端代码或提交到代码仓库。

每个 Key 可以单独设置:

  • 额度上限:用完即停,避免超支。
  • 可用模型:只开放项目需要的模型。
  • IP 白名单:只允许指定服务器调用。
  • 有效期:到期自动失效。
Key 泄露后,请立刻在控制台删除并重新创建,旧 Key 删除后即时失效。

接口地址

同一个 Key 可以调用以下接口格式:

对话补全
POST /v1/chat/completions
Responses
POST /v1/responses
向量
POST /v1/embeddings
图像生成
POST /v1/images/generations
模型列表
GET /v1/models
Claude 原生
POST /v1/messages
Gemini 原生
POST /v1beta/models/{model}:generateContent

某个模型支持哪些格式,以模型页标签为准。

对话补全

常用参数:model、messages、temperature、max_tokens、tools、response_format。参数含义与 OpenAI 一致,厂商不支持的参数会被忽略。

curl https://api.qyanhub.ai/v1/chat/completions \
  -H "Authorization: Bearer $QYAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "anthropic/claude-sonnet-5.5",
    "messages": [
      {"role": "system", "content": "你是一名简洁的助手"},
      {"role": "user", "content": "什么是 API 网关?"}
    ],
    "temperature": 0.7,
    "max_tokens": 512
  }'

流式输出

设置 stream: true,以 Server-Sent Events 逐段返回结果,适合聊天界面边生成边显示。

stream = client.chat.completions.create(
    model="deepseek/deepseek-v4-pro-0813",
    messages=[{"role": "user", "content": "写一首关于大海的短诗"}],
    stream=True,
)
for chunk in stream:
    delta = chunk.choices[0].delta.content or ""
    print(delta, end="", flush=True)

Claude 原生格式

使用 Anthropic SDK 或只支持 Anthropic 接口的工具时,把 Base URL 设为 https://api.qyanhub.ai(不带 /v1),API Key 用 QyanHub 的 Key。

import anthropic

client = anthropic.Anthropic(
    base_url="https://api.qyanhub.ai",
    api_key="sk-...",
)
msg = client.messages.create(
    model="anthropic/claude-opus-5.5",
    max_tokens=1024,
    messages=[{"role": "user", "content": "你好"}],
)
print(msg.content[0].text)

模型列表

返回当前 Key 可以调用的模型。

curl https://api.qyanhub.ai/v1/models \
  -H "Authorization: Bearer $QYAN_API_KEY"

路由与容灾

同一个模型可以接入多条上游渠道。网关按渠道权重和健康状况分配请求;某条渠道超时或报错时,自动重试并切换到其他渠道,调用方不需要做任何处理。

企业客户可以申请专属分组:独立的渠道池与价格,不与公共流量共享。

计费与用量

每次请求按输入、输出和缓存读取的 Token 数分别计费,从账户余额扣除。控制台「使用日志」里可以按 Key、模型和时间查看每一次请求的 Token 数与费用。

查看价格与费用估算 →

错误码

错误响应与 OpenAI 格式一致:

{
  "error": {
    "message": "model not found: foo/bar",
    "type": "invalid_request_error",
    "code": "model_not_found"
  }
}
HTTP含义处理建议
400请求参数有误检查 JSON 格式、必填字段和参数取值。
401认证失败API Key 缺失、错误或已被删除。
403无权访问Key 未开放该模型,或请求 IP 不在白名单内。
404模型不存在模型名拼写有误或未上架,请在模型页复制模型名。
429请求过快或余额不足降低并发、稍后重试,或在控制台充值。
500 / 502 / 503上游异常网关会自动重试并切换渠道;仍失败时请稍后重试。

客户端与工具

支持自定义 OpenAI 或 Anthropic 接口地址的工具,都可以接入 QyanHub。

聊天客户端

Cherry Studio、LobeChat、Chatbox 等:在「自定义 OpenAI 服务」里填写 Base URL 与 API Key。

编程工具

Claude Code、Cline、Continue 等:使用 OpenAI 兼容或 Anthropic 接口配置,模型名从模型页复制。

应用平台

Dify、n8n、FastGPT 等:新增 OpenAI 兼容的模型供应商。

SDK

OpenAI 官方 SDK(Python / Node / Go / Java)和 Anthropic SDK 都可以直接使用。