OpenAI Compatible API

从 NewAPI 令牌到生产调用

这份文档面向接入方说明公共调用方式。账号、令牌、渠道、额度和日志仍使用原 NewAPI 控制台管理。

基础配置

把当前站点作为 OpenAI 兼容网关使用。不要把请求发到静态页面路径。

Base URL

https://你的域名/v1

控制台

/login/token/channel 等路径保持 NewAPI 原样。

鉴权

所有模型接口请求都需要携带 NewAPI 令牌。建议按项目或使用方创建独立令牌, 便于限额、撤销和日志追踪。

请求头

Authorization: Bearer sk-...

Python SDK base_url
from openai import OpenAI

client = OpenAI(
    api_key="sk-...",
    base_url="https://你的域名/v1",
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[
        {"role": "user", "content": "测试连通性"}
    ],
)

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

常用接口

以下路径会直接反代到 NewAPI 后端,不经过静态页面。

POST/v1/chat/completions

用于多轮对话、工具调用和流式输出。支持参数以 NewAPI 当前上游渠道能力为准。

{
  "model": "gpt-4o-mini",
  "messages": [
    {"role": "system", "content": "你是一个简洁的助手"},
    {"role": "user", "content": "写一个健康检查请求"}
  ],
  "temperature": 0.7,
  "stream": true
}

GET/v1/models

返回当前令牌可访问的模型。若返回 401,请先检查令牌是否启用且额度充足。

curl https://你的域名/v1/models \
  -H "Authorization: Bearer $NEWAPI_KEY"

错误排查

先区分是鉴权、额度、模型名还是上游渠道问题,再进入控制台查看日志。

401

令牌无效

检查请求头格式、令牌状态、分组权限和是否复制了完整 Key。

429

限额或频控

查看用户额度、令牌限额、分组倍率和上游模型的速率限制。

5xx

上游异常

进入日志页查看请求 ID、渠道响应和是否需要切换模型渠道。