New APINew API
使用指南部署安装API 参考AI 应用Skills插件帮助支持商务合作合规与使用政策
⚠️合规提示:本项目仅用于合法授权的 API 网关、内部管理和私有化部署场景。请遵守上游服务条款、平台规则、监管要求和内容安全要求。
用户指南

概览

查看账户的额度、用量和请求次数,按设置引导和示例命令完成首次调用,并查看管理员发布的公告、API 信息、常见问答和运行状态。

  • 从侧边栏「常规」→「概览」进入。
  • 查看账户的额度和用量,按设置引导完成首次调用,查看管理员发布的公告等信息。
  • 「用量概览」中的额度、用量和请求次数仅统计当前账户。

提示

  • 登录后默认显示「概览」页。
  • 额度的单位由站点决定,金额按站点的货币显示方式显示。
  • 公告、API 信息、常见问答和运行时间的内容由管理员配置,未配置时面板中显示相应的提示,管理员关闭的面板不显示,见控制台内容配置。
  • 左侧边栏无「概览」页时:
    到「个人资料」页的「左侧边栏个人设置」区域中,开启「控制台区域」和「数据看板」并保存。「数据看板」开关同时控制「概览」和「数据看板」两个入口。

概览页面

  • 概览-总览

概览-总览页面

页面自上而下为设置引导、用量概览和信息面板,可完成以下操作:

提示

数值未更新、设置引导不消失或看不到某个面板时,查看常见问题

区域说明:

下表按页面中从上到下、从左到右的顺序排列。

区域定义显示条件备注
设置引导顶部标签为「开始使用」、标题为「几分钟内开始使用你的 API 网关」的卡片,列出「创建 API 密钥」「添加额度」「发送请求」三个步骤。未完成全部步骤时自动展开,全部完成后自动收起;手动展开或收起后,按手动的选择显示。已完成的步骤前显示绿色对勾。见按设置引导开始使用。
首个 API 请求一条可直接运行的 curl 调用命令,使用账户自己的 API 密钥。位于设置引导中,设置引导收起后不显示。下方「路由已启用」「认证已配置」「已选择模型」三行显示命令所用的地址、密钥和模型。见复制示例命令发送第一个请求。
推荐操作标题为「保持平台就绪」的快捷入口:「API 密钥」「渠道」(仅管理员可见)「使用日志」「定价」。随设置引导显示。设置引导收起且未全部完成时,入口移到收起后的一行中;全部完成并收起后不显示。点击打开对应页面,「定价」打开模型广场。
用量概览当前账户的「近 24 小时消耗」「历史使用情况」「请求计数」。始终显示。管理员账户同样仅统计自己的数据。各项的统计方法见查看额度和用量。
剩余额度当前账户的钱包余额、余额状态、近 24 小时消耗和「可用时长」。始终显示,位于「用量概览」右侧。不含订阅额度。余额状态见余额状态;点击「钱包」打开钱包页。
性能健康(仅管理员可见)全站最近 24 小时请求的「成功率」「平均延迟」「吞吐量」和「流量最高的模型」。仅管理员可见。统计所有用户的请求,不是当前账户的数据。无数据时三项显示「—」。模型名后的圆点按成功率着色:100% 深绿,90% 及以上浅绿,70% 及以上黄色,低于 70% 红色。
运行时间管理员配置的 Uptime Kuma 监控项,按分组显示各监控项的状态和近 24 小时在线率。管理员关闭该面板时不显示;未配置时显示「未配置正常运行时间监控」;无法获取监控状态时显示同一句,或分组下不显示监控项。圆点颜色见运行时间监控状态。
API 信息管理员提供的 API 地址,每条显示名称、说明和地址。管理员关闭该面板时不显示;未配置时显示「未配置 API 路由」。第 1 条地址用作「首个 API 请求」的请求地址。右侧可测试延迟、复制地址,见面板内操作。
公告管理员发布的公告,最新的排在最前。管理员关闭该面板时不显示;无公告时显示「目前暂无公告」。每条显示正文开头和发布时间,左侧圆点颜色表示管理员为公告选择的类型。点击打开「公告详情」。
常见问答管理员整理的问题和答案。管理员关闭该面板时不显示;无条目时显示「暂无 FAQ 条目」。点击问题展开答案。

按设置引导开始使用

操作流程:

  1. 点击步骤「1. 创建 API 密钥」,在「API 密钥」页创建密钥。
  2. 点击步骤「2. 添加额度」,在「钱包」页充值或兑换额度。
  3. 点击步骤「3. 发送请求」,在「游乐场」中发送一条消息;也可复制「首个 API 请求」中的命令,在终端中运行。
  4. 返回「概览」页,刷新浏览器页面,查看各步骤是否显示绿色对勾。
  5. 不需要设置引导时,点击右上角「隐藏设置引导」。

提示

  • 步骤是否完成取自登录时获取的账户信息,完成操作后请刷新浏览器页面。
  • 展开或收起的选择保存在当前浏览器中,之后不再随完成情况自动变化。
  • 收起后:未全部完成时显示一行「设置进度:…/3」,点击「显示设置引导」重新展开;全部完成时,点击页面标题右侧的「设置引导」重新展开。

步骤说明:

步骤说明完成条件点击后打开
1. 创建 API 密钥「为你的应用或服务创建密钥」账户中至少有一个 API 密钥,已禁用、已过期的密钥也计入。「API 密钥」页
2. 添加额度「生产流量前保持充足余额」钱包余额大于 0,或账户曾消耗过额度。注册时获得赠送额度的账户,该步骤一开始即为完成。「钱包」页
3. 发送请求「使用 Playground 或你的客户端验证路由」账户至少有一次成功的调用,失败的调用不计入。「游乐场」页;管理员关闭游乐场时回到「概览」页

复制示例命令发送第一个请求

操作流程:

  1. 账户尚无 API 密钥时,点击「首个 API 请求」右上角「创建 API 密钥」,创建密钥后返回「概览」页。
  2. 点击「首个 API 请求」右上角「复制」。
  3. 在终端中粘贴并运行命令。

注意保管密钥

复制的命令包含完整的 API 密钥,请勿发送到聊天群,或包含在截图、公开的代码仓库中。

提示

  • 命令适用于 macOS、Linux 终端和 Windows 的 Git Bash。
  • 「复制」会读取完整密钥,与在「API 密钥」页查看完整密钥一样受频率限制,审计日志中记为「查看 API 令牌「…」的密钥」。
  • 需要使用其他密钥或模型时,请在「API 密钥」页复制密钥和 API 地址,调用方式见 API 密钥。

命令说明:

组成部分取值备注
请求地址「API 信息」中第 1 条地址加 /v1/chat/completions;管理员未配置或关闭 API 信息时,为当前浏览器访问的站点地址加 /v1/chat/completions。「路由已启用」显示「在线」表示使用了 API 信息中的地址,显示「当前域名」表示使用当前站点地址。「在线」不表示已检测该地址可以访问。
API 密钥「API 密钥」列表中排在最前的已启用密钥;无已启用的密钥时,为排在最前的密钥。卡片副标题显示该密钥的名称,命令中仅显示密钥首尾几位,点击「复制」后才复制完整密钥。「认证已配置」显示「已保护」表示已有密钥,「需要 API 密钥」表示尚未创建。卡片中不可选择其他密钥。
模型账户可用模型中的第一个。显示在「已选择模型」中。未获取到可用模型时,「已选择模型」显示「加载中」,命令中的模型为 gpt-4o-mini。
请求内容一条英文对话消息,使用 ChatCompletions 格式。其他参数见 ChatCompletions 格式。

查看额度和用量

操作流程:

  1. 在「用量概览」中查看当前账户最近一天的消耗、累计消耗和累计调用次数。
  2. 在右侧「剩余额度」中查看钱包余额、余额状态和「可用时长」。
  3. 余额不足时,点击「钱包」充值或兑换额度。

提示

  • 「剩余额度」「历史使用情况」「请求计数」取自登录时获取的账户信息,在其他页面充值或调用后不会立即更新,刷新浏览器页面后显示最新数值。
  • 「剩余额度」仅为钱包余额,订阅的剩余额度在钱包页的「我的订阅」中查看。
  • 「近 24 小时消耗」与数据看板使用同一份汇总数据,新的调用通常几分钟后计入(默认每 5 分钟汇总一次)。

统计项说明:

统计项定义统计范围备注
近 24 小时消耗当前账户最近一天消耗的额度。按整点小时汇总,包含当前小时和之前的 22 个小时,略短于 24 小时;含钱包余额和订阅额度支付的消耗。管理员关闭数据看板的统计后不再增加。下方显示「近 24 小时消耗量」,按货币显示时后接单位,如「(USD)」。卡片底部的折线为这段时间的消耗变化。「剩余额度」中的「近 24 小时消耗」与此相同。
历史使用情况当前账户累计消耗的额度。自账户创建起,含钱包余额和订阅额度支付的消耗。下方显示「总消耗 (…)」,额度按 Token 显示时为「总消耗额度」。卡片底部的折线为最近一天的消耗变化,不是累计走势。
请求计数当前账户累计成功的调用次数。自账户创建起,失败的调用不计入。下方显示「总请求数」。卡片底部的折线为最近一天的调用次数变化。
剩余额度当前账户的钱包余额。不含订阅额度。右上角显示余额状态,见余额状态。
可用时长按最近一天的消耗速度估算的余额可用天数,即「剩余额度」除以「近 24 小时消耗」。与「剩余额度」「近 24 小时消耗」相同。显示「~… 天」(向下取整)、「999+ 天」或「剩余不足 1 天」;钱包余额不大于 0 时显示「余额已耗尽」;最近一天无消耗时显示「暂无使用记录」。

查看公告、API 信息、常见问答和运行时间

查看公告操作流程:

  1. 点击「公告」中的一条公告。
  2. 在「公告详情」窗口中查看「内容」;有附加信息时,下方显示「附加信息」。

测试 API 地址延迟操作流程:

  1. 点击「API 信息」中地址右侧的闪电图标(鼠标悬停显示「测试延迟」)。
  2. 查看图标左侧显示的耗时,如「120毫秒」,颜色的含义见 API 地址延迟。

查看运行时间操作流程:

  1. 在「运行时间」中按分组查看各监控项的圆点颜色和近 24 小时在线率。
  2. 需要最新状态时,点击面板右上角的刷新图标。

提示

  • 四个面板的内容由管理员在控制台内容配置中设置,管理员修改后,可能需要几分钟或刷新浏览器页面后才显示。
  • 「测试延迟」测量的是浏览器到该地址的往返时间,不代表模型的响应速度。「外部速度测试」在新标签页中打开第三方测速网站。

操作项说明

页面按钮

操作位置说明
设置引导页面标题右侧三个步骤全部完成后显示,点击展开或收起设置引导。
隐藏设置引导设置引导右上角收起设置引导,见按设置引导开始使用。
显示设置引导设置引导收起后的一行右侧未全部完成且已收起时显示,点击重新展开。
创建 API 密钥设置引导右上角;「首个 API 请求」右上角打开「API 密钥」页。「首个 API 请求」中的按钮仅在账户尚无密钥时显示。
1. 创建 API 密钥、2. 添加额度、3. 发送请求设置引导的步骤列表分别打开「API 密钥」「钱包」「游乐场」页。
复制「首个 API 请求」右上角复制含完整密钥的 curl 命令,复制期间显示「加载中」,见复制示例命令发送第一个请求。
API 密钥、渠道(仅管理员可见)、使用日志、定价「推荐操作」;设置引导收起后的一行中打开对应页面,「定价」打开模型广场。
钱包「剩余额度」底部打开「钱包」页。

面板内操作

操作位置说明
测试延迟「API 信息」中每条地址右侧的闪电图标从浏览器向该地址发送一次请求并显示耗时,见 API 地址延迟。
外部速度测试「API 信息」中每条地址右侧的仪表图标在新标签页中打开第三方测速网站测试该地址。窄屏时不显示。
复制 URL「API 信息」中每条地址右侧的复制图标复制该地址。
在新标签页中打开「API 信息」中每条地址右侧的外链图标在新标签页中打开该地址。窄屏时不显示。
查看公告详情「公告」中的每条公告打开「公告详情」窗口。
展开或收起答案「常见问答」中的问题展开或收起该问题的答案。
刷新「运行时间」右上角的刷新图标重新获取监控状态。面板显示「未配置正常运行时间监控」时不显示该图标,请刷新浏览器页面。

状态项说明

余额状态

「剩余额度」右上角显示的三种状态:

状态含义备注
正常钱包余额大于 0,且按最近一天的消耗估算可用 3 天及以上,或最近一天无消耗。绿色圆点。
余额偏低钱包余额大于 0,但按最近一天的消耗估算可用不足 3 天。黄色圆点,「可用时长」以黄色显示。3 天为固定值,与「个人资料」中的「余额不足提醒」无关。请前往钱包充值。
余额已耗尽钱包余额不大于 0。红色圆点,「可用时长」以红色显示。不含订阅额度:有生效的订阅时,调用仍可按计费偏好从订阅额度中扣除。

API 地址延迟

「API 信息」中点击闪电图标后显示的结果:

结果含义备注
测试中...正在测试。—
…毫秒(绿色)往返耗时低于 200 毫秒。—
…毫秒(黄色)往返耗时 200 毫秒及以上、低于 500 毫秒。—
…毫秒(红色)往返耗时 500 毫秒及以上。—
不适用测试失败,如地址无法访问。可点击仪表图标,用第三方网站测速。

运行时间监控状态

「运行时间」中监控项名称前的圆点颜色,状态由 Uptime Kuma 提供:

状态含义备注
绿色正常运行。—
红色故障。请联系管理员。尚无检测结果的监控项也显示红色。
黄色等待确认,监控正在重试。—
蓝色维护中。—
灰色状态未知。极少出现。

常见问题

相关文档

这篇文档对您有帮助吗?

最后更新于