OpenAI-compatible API

NBAPI 接入文档

NBAPI 提供 OpenAI 兼容接口。接入时只需在现有 SDK 或客户端中替换 Base URL,并使用 NBAPI 控制台生成的 API Key 即可调用。

Base URL https://www.nbapi.com.cn/v1

1. 登录账户

使用 GitHub、邮箱验证码或密码登录 NBAPI 门户。

2. 充值余额

余额用于 API 调用扣费。最低充值金额以充值页显示为准。

3. 创建 Key

进入 API Key 控制台创建密钥。完整 Key 只在创建时展示一次。

鉴权

所有请求都需要在 Header 中携带 API Key。

Authorization: Bearer YOUR_NBAPI_KEY
Content-Type: application/json
不要在前端浏览器、公开仓库、日志或截图中暴露完整 API Key。泄露后请立即在控制台撤销并重新创建。

Chat Completions

基础请求示例。

curl https://www.nbapi.com.cn/v1/chat/completions \
  -H "Authorization: Bearer YOUR_NBAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [
      { "role": "system", "content": "You are a helpful assistant." },
      { "role": "user", "content": "Summarize this API in one sentence." }
    ]
  }'

流式响应

设置 stream: true 后返回 SSE 数据流。

curl https://www.nbapi.com.cn/v1/chat/completions \
  -H "Authorization: Bearer YOUR_NBAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "stream": true,
    "messages": [
      { "role": "user", "content": "Write a short product tagline." }
    ]
  }'

模型列表

获取当前账户可见模型。

curl https://www.nbapi.com.cn/v1/models \
  -H "Authorization: Bearer YOUR_NBAPI_KEY"

模型可用性

  • 模型列表以 /v1/models 实际返回为准。
  • 调用时必须使用模型 ID,不要使用展示名。例如 Opus 4.7 请填 opus-4.7claude-opus-4.7claude-opus-4-7,不要填 Opus 4.7
  • 不同套餐、余额状态和渠道状态可能影响可见模型。
  • 价格与倍率以模型价格页和网关后台配置为准。

Claude Code 接入

Windows PowerShell 推荐配置。把 YOUR_NBAPI_KEY 替换成控制台创建时弹出的完整 Key。

[System.Environment]::SetEnvironmentVariable("ANTHROPIC_AUTH_TOKEN", "YOUR_NBAPI_KEY", "User")
[System.Environment]::SetEnvironmentVariable("ANTHROPIC_API_KEY", "", "User")
[System.Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", "https://www.nbapi.com.cn/v1", "User")
[System.Environment]::SetEnvironmentVariable("ANTHROPIC_MODEL", "claude-opus-4-7", "User")
[System.Environment]::SetEnvironmentVariable("CLAUDE_CODE_SKIP_FAST_MODE_ORG_CHECK", "1", "User")
Claude Code 会在客户端侧检查部分模型名。不要填 claude-3-5-sonnetOpus 4.7 这种展示名或不完整别名;优先使用控制台文档给出的 claude-opus-4-7,然后重开终端再运行 claude

SDK 示例

Node.js / OpenAI SDK

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.NBAPI_KEY,
  baseURL: "https://www.nbapi.com.cn/v1",
});

const completion = await client.chat.completions.create({
  model: "gpt-5.4-mini",
  messages: [
    { role: "user", content: "Explain NBAPI briefly." }
  ],
});

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

Python / OpenAI SDK

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_NBAPI_KEY",
    base_url="https://www.nbapi.com.cn/v1",
)

resp = client.chat.completions.create(
    model="gpt-5.4-mini",
    messages=[
        {"role": "user", "content": "Explain NBAPI briefly."}
    ],
)

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

客户端配置

Base URL
https://www.nbapi.com.cn/v1
API Key
API Key 控制台 创建并复制。
Model
选择 /v1/models 返回的模型 ID。

额度与扣费

余额

账户余额在控制台显示,API 请求会按模型价格和倍率扣除。

订单

充值成功后由支付回调入账。重复回调会做幂等处理。

用量

用量统计以网关记录为准,前台展示只做查询和汇总。

常见错误

401
API Key 缺失、错误、已撤销或没有按 Bearer 格式传入。
402 / 403
余额不足、模型未开放、用户组权限不足或渠道限制。
404
模型 ID 不存在,先调用 /v1/models 确认可用模型。
429
请求过快或达到并发限制,请降低频率后重试。
5xx
上游渠道或网关暂时异常,可稍后重试或切换模型。

支持

接入前检查

  • 已登录 NBAPI 账户。
  • 账户有可用余额或套餐额度。
  • 已创建并保存完整 API Key。
  • 客户端 Base URL 指向 https://www.nbapi.com.cn/v1

联系支持

如果请求失败,请提供请求时间、模型 ID、错误码和 request id。不要发送完整 API Key。