开放接口

账户与用量 API

把账户余额、请求记录和费用数据接入内部系统,供团队监控余额、同步记录和核算支出。

模型推理与账户数据,用两类接口

应用和 Agent 用模型接口生成内容;监控与报表用账户接口读取数据。它们使用不同的地址与密钥,不能互换。

模型推理 API
router-api.xiu.ai
使用模型调用密钥和准确模型 ID,按所选型号支持的协议发送文本、图片或视频请求。具体 Base URL 与请求路径见模型详情和接入文档。
账户与用量 API
api.xiu.ai
使用独立的开放接口密钥,读取所属 XiuAI 账户的余额、请求明细和费用汇总。这组接口不能生成内容、充值或修改账户。

接入团队已有的工作流程

余额监控

读取账户当前余额和累计消耗,在内部看板展示,并按你的规则设置余额提醒。

GET/open/v1/balance

请求记录同步

按时间、模型或访问密钥筛选请求,逐条同步用量、费用和请求状态,方便查询与核对。

GET/open/v1/requests

费用核算

查询指定时间段的用量与费用汇总,按模型和访问密钥查看支出,接入已有报表。

GET/open/v1/requests/summary

在应用和 Agent 中怎样分工

  1. 运行任务

    在应用服务端或受信任的客户端配置模型调用密钥。Codex、Claude Code 等客户端仍使用模型协议,不能把账户 API 地址填成模型 Base URL。

  2. 读取报表

    在服务端保存账户 API 密钥,按需读取余额和用量记录,再将所需数据交给内部看板或报表。查询参数和分页方式按文档实现。

  3. 限制数据范围

    usage:read 可以读取整个所属账户的用量;keyName 等筛选参数不是项目或客户之间的权限隔离。对外提供报表或 Agent 工具时,由你的服务端落实数据授权,只返回获授权的数据。

在控制台自助获取密钥

  1. 登录控制台

    使用 XiuAI 账户登录,进入「开放接口」页。

  2. 签发密钥

    填写名称,勾选余额或用量权限,按需设置有效期。

  3. 保存到服务端

    完整密钥只显示一次,复制后存入服务端环境变量或密钥管理服务。

  4. 随时调整

    可随时修改名称与权限,或吊销不再使用的密钥,立即生效。

独立的只读密钥,按需授予权限

账户与用量 API 使用独立的开放接口密钥,只能读取所属 XiuAI 账户的数据。模型调用密钥继续用于调用模型,两类密钥分别管理。登录控制台即可自行签发、修改和吊销。

余额权限
读取当前余额和累计消耗。
用量权限
读取请求明细及用量、费用汇总。