使用文档
本站基于 New API 网关,提供统一的 AI 模型接口,完全兼容 OpenAI 接口格式,可用于官方在线前端、第三方 AI 客户端、浏览器插件和你自己的开发项目。
一、三步快速开始
- 注册登录:打开
https://www.tianziapi.com,注册并登录账号(支持账号密码及已开启的第三方 OAuth 登录)。 - 创建密钥:进入「API 密钥」页面,创建一个 API 密钥(即 API Key,形如
sk-xxxx)并复制。 - 开始使用:
- 不想配置软件:直接用站内「游乐场 / 聊天」在线对话、生图;
- 接入第三方软件或代码:接口地址填
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密钥 |
填写要点:
- Base URL 一般填到
/v1即可,不要漏写/v1,也不要写成/v1/v1; - 少数软件要求填完整端点,就在
/v1后补/chat/completions; - 请使用
https地址;本地部署时形如http://localhost:3000/v1。
三种协议格式(进阶)
| 协议 | 路径 | 鉴权头 |
|---|---|---|
| OpenAI(默认,推荐) | /v1/chat/completions | Authorization: Bearer sk-xxx |
| Claude 原生 | /v1/messages | x-api-key: sk-xxx + anthropic-version: 2023-06-01 |
| Gemini 原生 | /v1beta/models/{模型}:generateContent?key=sk-xxx | URL 带 key 或请求头 x-goog-api-key |
三、创建与管理 API 密钥
API 密钥(API Key / 令牌)是调用接口的身份凭证,左侧菜单进入「API 密钥」(或 /keys)。
创建步骤
- 点击「创建 API 密钥」;
- 填写名称(建议按用途命名,如「ChatBox 专用」「项目测试」);
- 按需选择分组,设置额度、过期时间、模型限制、IP 白名单;
- 保存后在列表中点击掩码密钥,复制完整密钥(只完整展示一次,请妥善保存)。
配置项说明
| 设置项 | 作用 |
|---|---|
| 名称 | 区分不同应用 / 环境,建议一应用一密钥 |
| 分组 | 指定该密钥走哪个渠道分组,不同分组模型和计价可能不同 |
| 额度 | 限制该密钥最多能用多少(独立于账户余额) |
| 过期时间 | 到期后该密钥无法使用 |
| 模型限制 | 留空表示不限制;填写后只能调用指定模型 |
| IP 白名单 | 逐行填写 IP 或 CIDR,留空不限制 |
安全建议
- 密钥等同于密码,不要发到群聊、截图、公开仓库或 GitHub;
- 建议每个应用单独创建密钥并设置额度,泄露时单独删除即可;
- 怀疑泄露立即删除旧密钥并新建;
- 注意区分:「个人设置 → 安全设置 → 系统访问令牌」是管理接口用的,不要填进第三方 AI 客户端;调用模型只用
sk-开头的 API 密钥。
四、模型、分组与计费
模型名怎么填
- 模型名必须填写本站「模型广场」(定价页
/pricing)里实际存在的名称,点击模型名即可复制; - 不要臆造或直接照搬其他平台的模型名,否则会报
model not found/ 无可用渠道; - 模型可能随运营调整,以站内模型广场显示为准。
可用 GET https://www.tianziapi.com/v1/models(带鉴权头)拉取当前密钥可用的模型列表。
分组
创建密钥时选择分组,分组决定可用模型和计费倍率。常见如 default(默认)以及站点开设的其他分组,具体以下拉选项为准。
额度如何计算
消耗额度 = 分组倍率 × 模型倍率 ×(提示 token 数 + 补全 token 数 × 补全倍率)
- 输入、输出分别计价,输出(补全)倍率通常更高;
- 每个模型的具体单价见「模型广场」,可按每 1K / 1M Tokens 查看;
- 密钥额度与账户余额是两个概念:账户有钱但某密钥设了较小额度上限时,该密钥仍会提示额度不足。
五、代码调用示例
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/completions | OpenAI 兼容,最常用,支持流式 |
| Responses | POST /responses | OpenAI 新 Responses 格式 |
| 文本补全 | POST /completions | 传统补全接口 |
| Claude 对话 | POST /messages | Anthropic Messages 兼容 |
| 向量嵌入 | POST /embeddings | 文本转向量 |
| 生成图片 | POST /images/generations | 文生图 |
| 编辑图片 | POST /images/edits | 参考图改图 |
| 语音转文字 | POST /audio/transcriptions | 音频转写 |
| 音频翻译 | POST /audio/translations | 音频转英文文本 |
| 文字转语音 | POST /audio/speech | TTS |
| 重排序 | POST /rerank | RAG 相关性排序 |
| 内容审核 | 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 WebUI | OpenAI API 地址填 https://www.tianziapi.com/v1 与对应密钥 |
| LobeChat | OPENAI_PROXY_URL=https://www.tianziapi.com/v1 加密钥,需手动填写 |
| SillyTavern | API 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-密钥。
八、网页端在线使用
不想配置任何软件时,登录站点即可使用:
- 游乐场:选择分组和模型,可在线多轮对话、测试模型;
- 聊天:支持把配置一键导入 Cherry Studio、LobeChat、DeepChat 等已安装的客户端;
- 模型广场 / 排行榜:浏览全部可用模型、单价、性能状态与热度,点击复制模型名;
- 概览 / 数据看板:查看余额、消耗、请求数、成功率等。
九、额度、充值与订阅
左侧「钱包」(/wallet)集中管理余额、充值、兑换码、订单、订阅与邀请奖励。
- 余额:用于模型调用的内部额度,不是现金;「累计消耗」为历史用量。
- 在线充值:选择金额与支付方式(以页面显示为准,常见为易支付 / Stripe 等),支付完成后等待回调到账,不要重复支付。
- 兑换码:输入管理员发放的兑换码即可兑换额度,一码仅可用一次。
- 订阅套餐:周期性额度包,购买后在有效期内使用套餐额度;可在「我的订阅」查看状态与重置周期。
- 计费偏好:可选择优先 / 仅用订阅或钱包扣款。
- 邀请奖励:通过专属邀请链接邀请新用户注册,可获得奖励额度,满足条件后「转入余额」。
- 订单历史:查询最近的充值 / 支付订单。
支付成功但余额未及时更新时,保留订单号与支付凭证联系管理员,切勿重复下单。
十、日志与异步任务
- 使用日志:查看每次调用的时间、密钥、模型、Token、费用、耗时与详情,可按模型、时间、请求 ID 筛选,是排查问题的第一入口。
- 绘图日志 / 任务日志:Midjourney 绘图、视频、音乐等属于异步任务,提交后返回任务 ID,后台轮询更新状态。
- 任务状态:未启动 → 队列中 → 执行中 → 成功 / 失败。
- 失败退款:异步任务失败后,预扣额度一般会自动退还,并生成一条「退款」日志;请结合钱包余额与退款记录判断,不要只看「失败」状态。
十一、账号与安全
- 注册登录:支持账号密码、Passkey 及已开启的第三方登录;忘记密码可用邮箱重置。
- 个人资料:绑定邮箱 / 第三方账号、设置界面语言与通知、管理左侧边栏、每日签到领额度。
- 两步验证(2FA):推荐用 Authenticator 类 App 扫码开启,备用码只显示一次,请离线保存。
- Passkey 通行密钥:可用设备指纹 / 人脸 / PIN 无密码登录。
- 登录会话:可查看各设备登录记录,发现异常立即撤销会话并修改密码。
- 注销账号:在安全设置中可永久注销,操作不可恢复。
十二、常见错误排查
| 现象 / 报错 | 原因 | 解决办法 |
|---|---|---|
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,或在「个人设置 → 可用模型 / 模型广场」按分组查看。
十四、联系我们
配置过程中遇到问题,或不确定模型 / 分组如何选择,可通过以下方式联系:
- 客服 QQ:
627925249 - 客服微信:
vipxd1024 - 邮箱:
627925249@qq.com - 站点地址:
https://www.tianziapi.com
本文档基于 New API 官方文档整理精简,适用于本站用户接入使用。