Skip to main content
SeeDream Tasks API 的主要功能是通過輸入 SeeDream Images Generation API 生成的任務ID來查詢該任務的執行情況。 本文檔將詳細介紹 SeeDream Tasks API 的對接說明，幫助您輕鬆集成並充分利用該 API 的強大功能。通過 SeeDream Tasks API，您可以輕鬆實現查詢 SeeDream Images Generation API 的任務執行情況。

​
申請流程

要使用 SeeDream Images Generation API，首先到 Ace Data Cloud 控制台 獲取您的 API Token，留作備用。 如果你尚未登錄或註冊，會自動跳轉到登錄頁面邀請你註冊和登錄，完成後會自動返回當前頁面。 一個 API Token 即可調用平台所有服務，無需為每個服務單獨申請。 首次申請會贈送免費額度，可免費體驗；額度不足時可在 控制台 充值通用餘額。
📘 完整文檔：SeeDream Images Generation API →

​
請求示例

SeeDream Tasks API 可以用於查詢 SeeDream Images Generation API 的結果。關於怎樣使用 SeeDream Images Generation API，請參考文檔 SeeDream Images Generation API 。 我們以 SeeDream Images Generation API 服務返回的任務ID一個為例，演示如何使用該 API。假設我們有一個任務ID：20068983-0cc9-4c6a-aeb6-9c6a3c668be0，接下來演示如何通過傳入一個任務ID來。

​
任務示例圖

​
設置請求頭和請求體

Request Headers 包括：
  • accept：指定接收 JSON 格式的響應結果，這裡填寫為 application/json。
  • authorization：調用 API 的密鑰，申請之後可以直接下拉選擇。
Request Body 包括：
  • id：上傳的任務ID。
  • action：對任務的操作方式。
設置如下圖所示：

​
代碼示例

可以發現，在頁面右側已經自動生成了各種語言的代碼，如圖所示：

部分代碼示例如下：

​
CURL

​
響應示例

請求成功後，API 將返回此處任務的詳細信息。例如：
返回結果一共有多個字段，介紹如下：
  • success，此時視頻生成任務的狀態情況。
  • task_id，此時視頻生成任務 ID。
  • trace_id，此時視頻生成跟蹤 ID。
  • data，此時圖像生成任務的結果列表。
    • image_url，此時圖片生成任務的鏈接。
    • prompt，提示詞。
    • size: 生成圖的像素

​
批量查詢操作

這是針對多個任務ID來進行查詢任務詳細信息，與上面不同的是需要將action選中為retrieve_batch Request Body 包括：
  • ids：上傳的任務ID數組。
  • action：對任務的操作方式。
設置如下圖所示：

​
代碼示例

部分代碼示例如下：

​
響應示例

請求成功後，API 將返回此次所有批量任務的具體詳細信息。例如：
返回結果一共有多個字段，其中items是包含了批量任務的具體詳情信息，每個任務的具體信息與上文的字段一樣，字段信息如下。
  • items，批量任務的所有具體詳情信息。它是一個數組，每個數組的元素和上文查詢單個任務的返回結果格式是一樣的。
  • count，此處批量查詢任務的個數。
批量結果裡每個任務對象還帶有以下計時字段。
  • created_at，任務創建時間，Unix 時間戳（秒，浮點）。
  • started_at，任務開始執行時間，Unix 時間戳（秒，浮點）。
  • finished_at，任務完成時間，Unix 時間戳（秒，浮點）。任務未完成時不返回該字段。
  • elapsed，任務執行耗時，單位為秒（浮點，保留 3 位小數）。任務未完成時不返回該字段。

​
CURL

​
錯誤處理

在調用 API 時，如果遇到錯誤，API 會返回相應的錯誤代碼和信息。例如：
  • 400 token_mismatched：錯誤請求，可能是由於缺少或無效的參數。
  • 400 api_not_implemented：錯誤請求，可能是由於缺少或無效的參數。
  • 401 invalid_token：未授權，無效或缺少授權令牌。
  • 429 too_many_requests：請求過多，您已超過速率限制。
  • 500 api_error：內部伺服器錯誤，伺服器出現問題。

​
錯誤響應示例

​
結論

通過本文檔，您已經了解了如何使用 SeeDream Tasks API 進行查詢單個或批量任務的所有具體詳情信息。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題，請隨時聯繫我們的技術支持團隊。