使用文档 · New API

使用文档

本站基于 New API 网关,提供统一的 AI 模型接口,完全兼容 OpenAI 接口格式,可用于官方在线前端、第三方 AI 客户端、浏览器插件和你自己的开发项目。

一、三步快速开始

  1. 注册登录:打开 https://www.tianziapi.com,注册并登录账号(支持账号密码及已开启的第三方 OAuth 登录)。
  2. 创建密钥:进入「API 密钥」页面,创建一个 API 密钥(即 API Key,形如 sk-xxxx)并复制。
  3. 开始使用
    • 不想配置软件:直接用站内「游乐场 / 聊天」在线对话、生图;
    • 接入第三方软件或代码:接口地址填 https://www.tianziapi.com/v1,API Key 填刚才复制的密钥。
官方在线前端只需填 API Key,不需要手动填写接口地址;第三方软件才需要填接口地址。

二、接口地址与鉴权

所有第三方软件、代理程序、AI 前端、代码请求,统一使用下面的 API 地址

项目内容
站点地址https://www.tianziapi.com
API Base URL(最常用)https://www.tianziapi.com/v1
聊天接口https://www.tianziapi.com/v1/chat/completions
图片生成接口https://www.tianziapi.com/v1/images/generations
鉴权方式请求头 Authorization: Bearer sk-你的API密钥

填写要点:

三种协议格式(进阶)

协议路径鉴权头
OpenAI(默认,推荐)/v1/chat/completionsAuthorization: Bearer sk-xxx
Claude 原生/v1/messagesx-api-key: sk-xxx + anthropic-version: 2023-06-01
Gemini 原生/v1beta/models/{模型}:generateContent?key=sk-xxxURL 带 key 或请求头 x-goog-api-key

三、创建与管理 API 密钥

API 密钥(API Key / 令牌)是调用接口的身份凭证,左侧菜单进入「API 密钥」(或 /keys)。

创建步骤

  1. 点击「创建 API 密钥」;
  2. 填写名称(建议按用途命名,如「ChatBox 专用」「项目测试」);
  3. 按需选择分组,设置额度、过期时间、模型限制、IP 白名单;
  4. 保存后在列表中点击掩码密钥,复制完整密钥(只完整展示一次,请妥善保存)。

配置项说明

设置项作用
名称区分不同应用 / 环境,建议一应用一密钥
分组指定该密钥走哪个渠道分组,不同分组模型和计价可能不同
额度限制该密钥最多能用多少(独立于账户余额)
过期时间到期后该密钥无法使用
模型限制留空表示不限制;填写后只能调用指定模型
IP 白名单逐行填写 IP 或 CIDR,留空不限制

安全建议

四、模型、分组与计费

模型名怎么填

可用 GET https://www.tianziapi.com/v1/models(带鉴权头)拉取当前密钥可用的模型列表。

分组

创建密钥时选择分组,分组决定可用模型和计费倍率。常见如 default(默认)以及站点开设的其他分组,具体以下拉选项为准。

额度如何计算

消耗额度 = 分组倍率 × 模型倍率 ×(提示 token 数 + 补全 token 数 × 补全倍率)

五、代码调用示例

cURL:聊天

curl https://www.tianziapi.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-你的API密钥" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [{"role": "user", "content": "你好"}]
  }'

cURL:生成图片

curl https://www.tianziapi.com/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-你的API密钥" \
  -d '{
    "model": "gpt-4o-image",
    "prompt": "一只橘色小猫,柔和光线,高清",
    "size": "1024x1024"
  }'
返回一长串字符通常是图片的 base64 数据,代表生成成功,由前端转成图片显示即可;部分模型会返回图片 URL。

Python(OpenAI SDK)

pip install openai
from openai import OpenAI

client = OpenAI(
    api_key="sk-你的API密钥",
    base_url="https://www.tianziapi.com/v1",
)

resp = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "你好,介绍一下你自己"}],
)
print(resp.choices[0].message.content)

Node.js(OpenAI SDK)

npm install openai
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "sk-你的API密钥",
  baseURL: "https://www.tianziapi.com/v1",
});

const resp = await client.chat.completions.create({
  model: "gpt-4o-mini",
  messages: [{ role: "user", content: "你好" }],
});
console.log(resp.choices[0].message.content);

六、接口端点一览

所有端点都挂在 Base URL https://www.tianziapi.com/v1 之下,均使用 Authorization: Bearer sk-xxx 鉴权。

功能方法与路径说明
聊天补全POST /chat/completionsOpenAI 兼容,最常用,支持流式
ResponsesPOST /responsesOpenAI 新 Responses 格式
文本补全POST /completions传统补全接口
Claude 对话POST /messagesAnthropic Messages 兼容
向量嵌入POST /embeddings文本转向量
生成图片POST /images/generations文生图
编辑图片POST /images/edits参考图改图
语音转文字POST /audio/transcriptions音频转写
音频翻译POST /audio/translations音频转英文文本
文字转语音POST /audio/speechTTS
重排序POST /rerankRAG 相关性排序
内容审核POST /moderations文本审核
模型列表GET /models拉取可用模型
实时对话GET /realtime(WebSocket)实时语音
Gemini 原生/v1beta/models/{model}:{action}Gemini 格式
视频生成POST /videos异步任务,返回任务 ID
视频任务查询GET /videos/{task_id}查询异步任务状态

七、第三方客户端接入

通用规律:凡是支持「自定义 OpenAI / OpenAI API 兼容」的软件,都只需填两项——

填写项
API 地址 / Base URL / 接口地址https://www.tianziapi.com/v1
API Key / 密钥你在本站创建的 sk- 密钥
模型从本站模型广场复制的模型名

若软件要求填完整端点,则使用 https://www.tianziapi.com/v1/chat/completions

常见图形客户端

客户端接入要点
Cherry Studio设置 → 模型服务 → 添加,提供商选「OpenAI / NewAPI」,填 API 地址与密钥,再添加模型;也支持令牌页一键导入
DeepChat / AQBot / AionUi支持在令牌菜单一键唤起导入;手动配置选「OpenAI」类型,填站点地址与密钥后「同步模型」
ChatBox设置 → 自定义 OpenAI:API 地址填 /v1,填 Key 与模型名
NextChat自建时 BASE_URL 填站点根地址(不带 /v1),密钥填 sk-xxx
Open WebUIOpenAI API 地址填 https://www.tianziapi.com/v1 与对应密钥
LobeChatOPENAI_PROXY_URL=https://www.tianziapi.com/v1 加密钥,需手动填写
SillyTavernAPI Connections → Chat Completion(OpenAI),地址填 /v1,填密钥与模型
FluentRead 翻译插件翻译服务选 NewAPI,接口填站点根地址(不带 /v1),填密钥并选模型

命令行 / 编程类工具

Claude Code(Anthropic 格式,注意地址不带 /v1)

# macOS / Linux:写入 shell 配置后 source 生效
export ANTHROPIC_BASE_URL="https://www.tianziapi.com"
export ANTHROPIC_AUTH_TOKEN="sk-你的API密钥"
claude
# Windows PowerShell(当前窗口生效)
$env:ANTHROPIC_BASE_URL="https://www.tianziapi.com"
$env:ANTHROPIC_AUTH_TOKEN="sk-你的API密钥"
claude

OpenAI Codex CLI(OpenAI 格式,地址带 /v1)

安装:npm i -g @openai/codex。编辑 ~/.codex/config.toml

model = "gpt-5-codex"
model_provider = "custom"
model_reasoning_effort = "medium"
disable_response_storage = true

[model_providers.custom]
name = "custom"
base_url = "https://www.tianziapi.com/v1"
wire_api = "responses"

同目录 ~/.codex/auth.json

{ "OPENAI_API_KEY": "sk-你的API密钥" }
更多客户端(CC Switch、Factory Droid、AstrBot、LangBot、Memoh、OpenClaw、LunaTranslator 等)的图文教程见官方文档 https://docs.newapi.pro/zh/docs/apps,填法一致:OpenAI 兼容地址 + sk- 密钥。

八、网页端在线使用

不想配置任何软件时,登录站点即可使用:

九、额度、充值与订阅

左侧「钱包」(/wallet)集中管理余额、充值、兑换码、订单、订阅与邀请奖励。

支付成功但余额未及时更新时,保留订单号与支付凭证联系管理员,切勿重复下单。

十、日志与异步任务

十一、账号与安全

十二、常见错误排查

现象 / 报错原因解决办法
401 Unauthorized / Invalid token密钥错误、过期、被禁用,或误填了系统访问令牌重新复制完整的 sk- 密钥;不要写成 sk-sk-xxx
提示额度不足账户余额不足,或该密钥自身额度用尽充值 / 换密钥;编辑密钥提高额度上限
model not found / 无可用渠道模型名填错,或密钥分组无该模型权限到模型广场复制正确模型名;更换支持该模型的分组与密钥
404接口地址错误Base URL 应为 https://www.tianziapi.com/v1,别漏 /v1 也别重复
当前分组负载已饱和,请稍后再试上游暂时繁忙(429)稍后重试,或更换模型 / 分组
fetch failed / 连接超时网络不通、超时太短、HTTPS 页面调用了 http 接口检查网络;生图较慢,客户端超时建议设 120–180 秒;统一用 https
返回一大段字符多为图片 base64属正常,前端转成图片显示即可
请求很慢模型排队或生图 / 长上下文耗时稍候重试、缩短上下文或换模型
生图 / 视频任务一直不动异步任务轮询有间隔到「任务日志」看状态;失败会自动退款
排查顺序建议:使用日志按请求 ID 定位 → 核对密钥与分组 → 核对模型名 → 核对 Base URL → 查看余额 / 额度

十三、常见问题

Q:账户里有额度,为什么还提示额度不足?
A:密钥额度与账户额度相互独立。密钥上设置的额度是它的用量上限,到上限后即使账户有余额也会被拦,编辑该密钥即可调整。

Q:官方在线前端要填接口地址吗?
A:不需要,填 API Key 即可;只有第三方软件 / 代码才需要填 https://www.tianziapi.com/v1

Q:一个密钥能给多个软件用吗?
A:技术上可以,但建议一应用一密钥,便于单独限额、看日志和吊销。

Q:流式输出(stream)支持吗?
A:支持,/v1/chat/completions"stream": true 即可。

Q:怎么知道我的密钥能调用哪些模型?
A:调用 GET /v1/models,或在「个人设置 → 可用模型 / 模型广场」按分组查看。

十四、联系我们

配置过程中遇到问题,或不确定模型 / 分组如何选择,可通过以下方式联系:


本文档基于 New API 官方文档整理精简,适用于本站用户接入使用。