账户信息
读取和更新 Open API 账户信息与额度状态。
账户信息
Profile 接口用于读取 API 密钥所属账户的用户 ID、会员层级、积分和 API 额度。批量任务开始前、关键任务完成后、线上排查时,都可以调用该接口做轻量检查。
查询账户信息
GET /api/open/v1/profile
Authorization: Bearer YOUR_API_KEY请求
该请求不需要请求体。
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer YOUR_API_KEY"响应
{
"user_id": "user_123",
"api_quota_remaining": 988000,
"tier": "pro",
"credits": 1200
}字段说明:
| 字段 | 说明 |
|---|---|
user_id | API 密钥所属用户 ID |
api_quota_remaining | 当前剩余 API 额度 |
tier | 当前账户层级 |
credits | 当前账户可用积分余额 |
客户端应把未知字段视为附加元数据,避免响应增加账户或计费字段时解析失败。
更新账户配置
POST /api/open/v1/profile
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json{
"webhookUrl": "https://example.com/webhooks/fishspeech"
}可更新字段由服务端控制。未知字段可能被忽略或拒绝。建议把账户配置更新和媒体任务创建分开,避免配置校验错误影响生成任务。
计费与积分
Profile 接口本身不消耗积分。它适合在批量任务前做额度检查,但不是额度锁定机制;检查完成到真正提交生成请求之间,账户余额仍可能被其它任务消耗。
对余额敏感的工作流,建议把 Profile 快照和你的批次 ID 一起记录。如果后续任务因额度不足失败,该快照可以帮助判断是提交前余额不足,还是并发任务消耗导致。
错误行为
| 状态码 | 场景 | 处理建议 |
|---|---|---|
401 | API 密钥缺失或无效 | 停止任务并刷新服务端密钥 |
402 | 相关操作触发额度检查失败 | 提示充值或升级状态 |
500 | 账户信息服务读取或更新失败 | 有限次数退避重试 |