API Reference
錯誤
解讀請求錯誤與失敗的影像任務。
如何解讀錯誤
HTTP 狀態碼描述的是發往 API 的這次請求,error.code 描述的是失敗的原因。兩者是彼此獨立的欄位:HTTP 200 並不是業務錯誤碼。
- 被拒絕的提交會回傳 HTTP 錯誤狀態碼,並帶有一個
error物件。 - 成功的任務查詢會回傳 HTTP 200。請讀取
status判斷生成處於processing、completed還是failed。 - 對於失敗的任務,請依據
error.code分支處理,而不是依據message中的文字。不同的失敗原因對應不同的錯誤碼;同一原因在不同模型下使用相同的錯誤碼。 - 當無法判定更具體的對外原因時,會回退為
60002。對於未來新增而你尚未識別的錯誤碼,請以一般性失敗處理。
下表中的錯誤碼與提示訊息由 API 直接回傳,因此保持英文原文,與用戶端實際收到的 error.message 字串逐字一致。
Request errors
These HTTP statuses describe a rejected or unconfirmed submission, or a failed task query. A submission timeout does not prove that no task was created.
Error code (error.code) | HTTP status | Meaning | Next step |
|---|---|---|---|
10001 | 401 | The API key is missing or invalid. | Check the Authorization header and API key. |
10002 | 403 | You do not have permission to make this request. | Check access permissions. |
20001 | 400, 413, 422 | The request was rejected. Check the parameters against the API documentation. | Correct the request parameters before retrying. |
20002 | 400 | The requested model is not available. | Select a model listed in the model catalog. |
30001 | 402 | Not enough credits to run this request. | Add credits before submitting. |
30002 | 429 | Too many requests. Please wait and try again. | Wait and retry with backoff. Do not repeat accepted submissions. |
50001 | 404 | Task not found. | Check the task ID and use the owning account’s key. |
50002 | 503 | Submission could not be confirmed. Check your tasks before submitting again. | Check task history before submitting again; the request may have been accepted. |
90001 | 503 | The service is temporarily unavailable. | Back off; retain any task ID already received. |
Task failures
A successful task query returns HTTP 200 even when generation failed. Check status: "failed" and error.code in the response. These codes describe the task outcome, not the HTTP request. Failed tasks are not charged.
Error code (error.code) | Meaning | Next step |
|---|---|---|
20001 | The request was rejected. Check the parameters against the API documentation. | Correct the request parameters before retrying. |
50003 | The task did not complete within the allowed time. Please try again. | The task is not charged. You may submit a new task. |
60001 | The request was rejected by the content policy. Please revise the prompt or input images. | Revise the prompt or media input. |
60002 | Generation could not be completed. Please try again. | The task is not charged. You may submit a new task. |
60003 | No output was generated. Please revise the prompt or try again. | Revise the input or submit a new task. |
60004 | The generated output could not be delivered. Please try again. | The task is not charged. Try again later. |
90001 | The service is temporarily unavailable. | Back off; retain any task ID already received. |
{
"id": "task_...",
"status": "failed",
"error": {
"code": 60002,
"message": "Generation could not be completed. Please try again."
}
}如果提交本身逾時,請先檢查你的任務歷史再重新提交:第一次請求有可能已經被受理。
