快速開始
原生圖片端點預設同步。將布林值async 設為 true 可建立背景任務;以下使用 qwen-image-2.0。
如何探索非同步媒體模型並取得 Schema
探索流程分為兩個步驟。先從公開模型目錄取得支援非同步介面的文生圖或文生影片模型,再使用模型的model_id 取得對應端點的請求 Schema。
取得支援非同步介面的模型清單
模型目錄與 Playground 使用相同的資料來源。type=image_generation 回傳文生圖模型,type=video 回傳文生影片模型。加入 schema_checked=true 後,清單只包含已發布並核對請求 Schema 的模型。
type 篩選目前只接受一個值,因此需要分別請求兩種模型類型。
回應格式為 {success, message, data}。data 中與非同步媒體整合相關的欄位如下。
取得單一模型的請求 Schema
不同模型支援的欄位、列舉和數值範圍可能不同。提交圖片或影片請求前,可以透過同一個公開介面取得指定模型目前可用的端點和請求 JSON Schema。modality 為 image 或 video。endpoints 陣列中的每一項描述一個可用的呼叫協定。
同一個模型可能同時回傳
/ai/v1 與 OpenAI 相容 /v1 端點。OpenAI 相容介面可能暫不支援最新模型,請優先使用 /ai/v1 端點。非同步任務介面應依 path 選擇 /ai/v1/images/generations 或 /ai/v1/videos,再讀取該項目的 request.schema。不要依賴 endpoints 陣列位置。
下面的命令可以直接擷取兩個非同步任務端點的請求 Schema。
404 model_not_found。端點資料暫時無法使用時回傳 500 endpoints_unavailable。
如何建立圖片任務
同步圖片
省略async 或設定為 false 時,介面會等待生成完成並回傳任務物件:
GET /ai/v1/images 尋找對應任務。
非同步圖片
將async 設定為布林值 true 後,介面會立即回傳任務物件,生成在背景繼續:
GET /ai/v1/images/{id} 查詢非同步圖片任務。完成後,直接請求每個 output 項目中的 content_url;該 URL 已包含對應圖片的 result_id。
圖片請求中的
async 必須是布林值。webhook_url 和 webhook_events_filter
僅能與 async: true 一起使用。圖片標準欄位
媒體任務物件
圖片和影片專用介面回傳以下結構:
媒體
output 項目:
狀態說明
用戶端可以每 15 秒查詢一次,直到狀態變為
completed、failed 或 cancelled。15 秒是用戶端輪詢建議,不是伺服器協定限制。
如何查詢媒體任務
查詢媒體詳情
查詢媒體清單
建立回應遺失時,可以透過對應媒體清單找回任務 ID:如何使用統一任務介面
統一任務介面支援以下篩選條件:
統一任務詳情:
output 項目:
/ai/v1/tasks/{id}/content。多產物任務需要請求 /ai/v1/tasks/{id}/content/{result_id};未指定結果 ID 時回傳 400 result_id_required。
統一任務清單、詳情和內容介面按建立任務時的 Bearer Token 隔離。同一帳戶下的其他
API Key 無法讀取該任務。
如何下載媒體結果
下載圖片
圖片完成後,逐項請求媒體任務物件中的output[].content_url:
/ai/v1/images/{id}/content/{result_id}。媒體任務物件不另外公開 result_id,用戶端直接使用 content_url 即可。
當 b64_json 非空時,可以直接對該欄位進行 Base64 解碼。
如何使用 Webhook
非同步圖片和影片支援任務層級 Webhook:webhook_url 最長 512 個字元,並且不能指向本機、私人網路或其他受限位址。省略 webhook_events_filter 時,平台推送 completed、failed 和 cancelled;明確傳入時,陣列不可為空、不可重複,並且必須與 webhook_url 一起使用。
未在請求中傳入 webhook_url 時,非同步圖片和影片會嘗試使用帳戶中設定的預設回呼位址。無效的帳戶預設位址會被忽略,不會阻止任務建立。
回呼請求
results 僅在結果已存檔時出現,下載仍需要 Bearer Token。
重試與去重
平台採用至少一次投遞,同一個事件可能重複送達:- HTTP
2xx表示接收成功。 - HTTP
5xx、網路錯誤或逾時會觸發重試。 - HTTP
3xx和4xx不會重試。 - 最多投遞 6 次,重試間隔依序為 1、4、16、64、256 秒。
event_id,重複收到相同事件時直接回傳 2xx。
錯誤回應與錯誤碼
error.tid 是請求追蹤 ID,聯絡技術支援排查時請一併提供。