跳到主要內容

API 文件 · 入門

Key 權限與限額

scope、模型白名單、累計與每日限額、停用與撤銷。

一個帳號可以建立多組 Key,建議每個應用程式或環境各用一組,方便分別設定限額與撤銷。

權限(scope)

scope允許的操作
tasks:create送出影片生成任務,會凍結並結算額度
tasks:read查詢本帳號的任務狀態與結果
assets:read列出與檢視素材
assets:write上傳、匯入、重新命名與刪除素材

模型白名單

Key 只能呼叫建立時勾選的模型,且必須是帳號已獲授權的模型。平台新上架的模型不會自動加入既有 Key 的白名單。

限額

  • 累計上限(必填):該 Key 已結算與凍結中的金額合計不得超過此值。
  • 每日上限(選填):以本站時區(Asia/Shanghai)的日曆日計算。
  • RPM 與並行上限(選填):超過時回傳 429 rate_limited,請見速率限制。
  • 有效期限(選填):過期後請求回傳 401 invalid_api_key。

Key 限額不足時回傳 402 key_limit_exceeded;帳號可用額度不足時回傳 402 quota_exceeded。

停用與撤銷

停用可隨時恢復;撤銷則無法復原。兩者都會讓使用該 Key 的請求立即回傳 401,歷史任務與帳單仍會保留。

cURL
curl https://cn-api.aitoken.tools/v1/account/quota \
  -H "Authorization: Bearer $AITOKEN_API_KEY"

# {
#   "object": "quota",
#   "currency": "CNY",
#   "available": "496.800000",
#   "reserved": "3.200000",
#   "key": { "id": "key_xxx", "total_remaining": "96.800000", "daily_remaining": null }
# }