API 文件
錯誤
穩定的錯誤結構、錯誤碼與 HTTP 狀態
錯誤採用固定的封裝結構,且絕不含非公開的診斷資訊:
{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "The request is invalid.",
"request_id": "req_012345"
}
}| HTTP | 錯誤碼 | 意義 |
|---|---|---|
| 400 | INVALID_REQUEST | 主體、表單欄位、標頭或影像不合法 |
| 400 | CONTENT_POLICY_VIOLATION | 此請求無法處理 |
| 401 | UNAUTHORIZED | API 金鑰缺少或無效 |
| 402 | INSUFFICIENT_CREDITS | 可用餘額不足 |
| 403 | FORBIDDEN | 缺少所需權限範圍或 Beta 存取權 |
| 404 | JOB_NOT_FOUND | 任務不存在,或屬於其他帳號 |
| 409 | IDEMPOTENCY_CONFLICT | 相同金鑰被用於不同內容 |
| 409 | JOB_CANCELED | 任務已被取消 |
| 429 | RATE_LIMIT_EXCEEDED | 超出請求上限 |
| 500 | JOB_FAILED | 影像任務無法完成 |
| 500 | INTERNAL_ERROR | 請求無法完成 |
上傳大小超限會以 HTTP 413 搭配 INVALID_REQUEST 回傳。429 與尚未進入終態的
任務,請依文件所述的延遲時間視為可重試。其他錯誤請修改請求,或附上 request_id
聯絡技術支援;不要用給人看的訊息作為程式邏輯的判斷依據。

API 文件