Skip to main content
本文將介紹一種 Hailuo Videos Generation API 對接說明,它是可以通過輸入自定義參數來生成Hailuo官方的視頻。

申請流程

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

基本使用

首先先了解下基本的使用方式,就是輸入提示詞 prompt、 生成行為 action、首幀參考圖片 first_image_url 以及模型 model,便可獲得處理後的結果,首先需要簡單地傳遞一個 action 字段,它的值為 generate,然後我們還需要輸入模型,目前主要有圖生視頻模型 minimax-i2v 和文生視頻模型 minimax-t2v,具體的內容如下:

可以看到這裡我們設置了 Request Headers,包括:
  • accept:想要接收怎樣格式的響應結果,這裡填寫為 application/json,即 JSON 格式。
  • authorization:調用 API 的密鑰,申請之後可以直接下拉選擇。
另外設置了 Request Body,包括:
  • model:生成視頻的模型,主要有圖生視頻模型 minimax-i2v 和文生視頻模型 minimax-t2v 兩種。
  • action:此次視頻生成任務的行為。
  • first_image_url:當選擇圖生視頻模型 minimax-i2v 就必須需要上傳的首幀參考圖片鏈接,不支持Base64編碼。
  • prompt:提示詞。
  • callback_url:需要回調結果的URL。
  • async:可選,設為 true 時接口立即返回 task_id,無需提供 callback_url,隨後通過對應的任務查詢接口輪詢獲取結果。
選擇之後,可以發現右側也生成了對應代碼,如圖所示:

點擊「Try」按鈕即可進行測試,如上圖所示,這裡我們就得到了如下結果:
返回結果一共有多個字段,介紹如下:
  • success,此時視頻生成任務的狀態情況。
  • task_id,此時視頻生成任務ID。
  • trace_id,此時視頻生成跟蹤ID。
  • data,此時視頻生成任務的結果列表。
    • id,此時視頻生成任務的視頻ID。
    • prompt,此時視頻生成任務的提示詞。
    • model,此時視頻生成任務的封面鏈接。
    • video_url,此時視頻生成任務的視頻鏈接。
    • state,此時視頻生成任務的狀態。
可以看到我們得到了滿意的視頻信息,我們只需要根據結果中 data 的視頻鏈接地址獲取生成的Hailuo視頻即可。 另外如果想生成對應的對接代碼,可以直接複製生成,例如 CURL 的代碼如下:

異步回調

由於 Hailuo Videos Generation API生成的時間相對較長,大約需要 1-2 分鐘,如果 API 長時間無響應,HTTP 請求會一直保持連接,導致額外的系統資源消耗,所以本 API 也提供了異步回調的支持。 整體流程是:客戶端發起請求的時候,額外指定一個 callback_url 字段,客戶端發起 API 請求之後,API 會立馬返回一個結果,包含一個 task_id 的字段信息,代表當前的任務 ID。當任務完成之後,生成視頻的結果會通過 POST JSON 的形式發送到客戶端指定的 callback_url,其中也包括了 task_id 字段,這樣任務結果就可以通過 ID 關聯起來了。 下面我們通過示例來了解下具體怎樣操作。 首先,Webhook 回調是一個可以接收 HTTP 請求的服務,開發者應該替換為自己搭建的 HTTP 伺服器的 URL。此處為了方便演示,使用一個公開的 Webhook 樣例網站 https://webhook.site/,打開該網站即可得到一個 Webhook URL,如圖所示: 將此 URL 複製下來,就可以作為 Webhook 來使用,此處的樣例為 https://webhook.site/580b81f5-596e-4321-b03f-606770b0bb83 接下來,我們可以設置字段 callback_url 為上述 Webhook URL,同時填入相應的參數,具體的內容如圖所示:

點擊運行,可以發現會立即得到一個結果,如下:
稍等片刻,我們可以在 https://webhook.site/580b81f5-596e-4321-b03f-606770b0bb83 上觀察到生成視頻的結果,如圖所示: 內容如下:
可以看到結果中有一個 task_id 欄位,其他的欄位都和上文類似,通過該欄位即可實現任務的關聯。

錯誤處理

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

錯誤響應示例

結論

通過本文檔,您已經了解了如何使用 Hailuo Videos Generation API 可通過輸入提示詞以及首幀參考圖片來生成視頻。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題,請隨時聯繫我們的技術支持團隊。