跳转到内容

积分与用量

收费服务使用账号积分结算。金额以毫积分(millicredits)表示,1000 毫积分等于 1 积分。请求中传入的金额必须是整数;余额和凭证中的金额可能带一位小数(精度见响应中的 credit_precision)。

GET /api/v1/billing/credits/balance
Terminal window
curl https://omnidoc.top/api/v1/billing/credits/balance \
-H "X-API-Key: $OMNIDOC_API_KEY"

关键字段:

字段含义
available当前可用毫积分,已扣除欠款;欠费时为负数
debt欠款毫积分:已完成任务的实际费用超出余额的部分。之后到账的积分(充值、每日赠送、兑换码、退款等)先抵扣欠款
spent已结算的累计毫积分
expired已失效或被撤回的毫积分
today_charged当日已结算毫积分
lots当前有效积分批次及到期时间
  1. 开始前按门槛检查余额:余额(已扣除欠款)须高于任务的门槛,例如 PDF 文件翻译为“页数 × 2 积分”,其他文件按原文字数,最少 2 积分。使用设有额度的 API Key 时,该 Key 的剩余额度也须高于门槛。不满足时返回 402(文件翻译任务以 quota_exceeded=true 失败结束),不扣费。开始处理不会改变余额。
  2. 完成后按实际用量扣费:文件翻译(含图片)、富文本分批、文档操作等在完成时按实际用量全额扣除,不受请求中的上限或 API Key 额度限制。API Key 的已用额度因此超过其额度时,该 Key 不能再发起新任务,直到额度调高。任务失败或取消不扣费。音视频与语音任务按服务端测得的实际时长扣费,最多不超过开始时的可用余额。
  3. 余额可能为负:实际费用超过余额的部分记为欠款,余额显示为负数;之后到账的积分先抵扣欠款。余额为负时新任务无法开始,请充值。

客户端不提交“实际应扣多少”;结算量由服务端根据交付结果计算。

GET /api/v1/billing/credits/operations?limit=20
GET /api/v1/billing/credits/operations/{operation_id}
GET /api/v1/billing/credits/jobs/{job_id}

凭证包含操作 ID、状态、计费依据、实扣和退款金额。使用 API Key 查询操作列表时,只返回该 Key 发起的操作。

GET /api/v1/usage?limit=50
GET /api/v1/usage/summary

用量接口返回账号的文件数、字符数、Token 数和处理时长。

查询余额、任务状态、用量、结算凭证、结果列表和下载地址都不扣积分。