Developer guide

十分钟完成第一次调用

青衡实现 OpenAI Chat Completions 兼容接口。你的平台 API Key 只显示一次,请放在服务端环境变量中。

安装 SDK

pip install -U openai

配置鉴权

在控制台创建 Key。完整密钥仅展示一次,平台数据库仅保存不可逆哈希。不要把 Key 放在浏览器、移动 App 或公开仓库。

export QINGHENG_API_KEY="qh_live_..."

发起请求

from openai import OpenAI
import os

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

response = client.chat.completions.create(
    model="qwen3.7-plus",
    messages=[{"role": "user", "content": "用三句话解释向量检索"}],
    max_tokens=500
)

print(response.choices[0].message.content)

限流与预算

每个 Key 独立执行 RPM、TPM、最大并发、每日预算和月度预算。流式请求开始前会按最大可能费用预占,结束后自动释放差额。

错误处理

每个响应都带 x-request-id。429 不会无限重试;上游结果不确定时返回 provider_result_unknown,平台会保留预占并人工核对。

{
  "error": {
    "message": "余额不足",
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_..."
  }
}

安全建议

  • 生产、测试、客户项目分别创建 Key。
  • 设置 IP 白名单、到期时间和尽可能小的预算。
  • 发现泄漏后立即轮换;旧 Key 会立刻失效。
  • 使用 Idempotency-Key 防止网络重试重复提交。