跳到主要內容
指南
指南

快速入門

建立非同步任務,並處理輪詢、完成、失敗與回呼。

RunAPI 使用任務(Task)進行非同步的圖像、影片、音訊及音樂生成。建立請求會迅速返回;您的應用程式隨後對任務進行輪詢,或接收該端點 API 參考中列出的回呼事件。

建立任務

在目錄中選擇模型與端點,然後傳送端點所需的輸入內容。以下範例啟動一個 Flux 2 文字轉圖片任務:

SHELL
curl -X POST "https://runapi.ai/api/v1/flux_2/text_to_image" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Idempotency-Key: 8c8ba3c9-0ce0-4bbd-a9a7-bf59ab639286" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "flux-2-pro-text-to-image",
    "prompt": "A product photograph on a clean studio background"
  }'

已接受的非同步請求會回傳 202 Accepted 及任務識別碼:

JSON
{
  "id": "task_id",
  "status": "processing"
}

id 與您的應用程式記錄一同儲存。它是用於輪詢、支援及回呼對帳的穩定識別碼。

防止重複建立任務

任務建立端點接受一個選用的 Idempotency-Key 標頭,其值為最多 512 個字元的不透明字串。請為每個邏輯任務產生一個值,並在確認請求是否已被接受之前,隨請求一併保留該值。

若因逾時或連線失敗而導致結果不明,請以相同的金鑰重試完全相同的 Task 建立請求。RunAPI 將回傳原始 Task,而不會建立並收費第二次。以不同的 Task 建立請求重複使用同一金鑰將回傳 409 Conflict。請為全新的 Task 產生新金鑰,且不要將 X-Client-Request-Id 用作此金鑰。

恢復中斷的同步請求

緩慢的同步端點通常會保持連線開啟,並如既往回傳相同的終止回應。現有整合無需變更輪詢邏輯。

若要設定刻意較短的連線預算,請傳送 Prefer: wait=N。 若 Task 在該明確預算結束後仍在執行,RunAPI 將回傳 202 Accepted,附帶相同的 Task id、用於恢復的不透明 Location URL 及建議的查詢延遲 Retry-After。請完全依照 Location 指引, 而非自行建構結果 URL。已完成的 Task Result 會保留終態 HTTP 狀態、 允許的標頭、內容類型及主體;請依 response.content_type 解碼 response.body,其並非總是 JSON。

輪詢任務

將任務識別碼附加至相同的端點路徑:

SHELL
curl "https://runapi.ai/api/v1/flux_2/text_to_image/task_id" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

statusprocessing 時持續輪詢。請在請求之間使用有界退避策略,而非持續不斷地輪詢。當任務狀態變為 completedfailed 時,即進入終態。

處理完成

completed 回應包含任務的 id、終止的 status,以及端點特定的結果欄位。請持久化您所需的結果並停止輪詢。請參閱端點的 API 參考以取得確切的結果結構,而非假設每個媒體端點都會回傳相同的欄位。

處理失敗

failed 回應包含任務的 id、終止的 status,以及在可用時由 RunAPI 提供的 error。請停止輪詢,記錄識別碼與錯誤,並僅在您的應用程式將失敗分類為暫時性錯誤時才重試。重試會產生新的任務識別碼。

接收回呼

若希望 RunAPI 傳送為該端點所記錄的回呼事件,請在建立請求時加入公開的 HTTPS callback_url

JSON
{
  "model": "flux-2-pro-text-to-image",
  "prompt": "A product photograph on a clean studio background",
  "callback_url": "https://your-domain.com/webhooks/runapi"
}

每個回呼主體對應端點 API 參考中的一個生命週期事件,並省略僅限輪詢的計費詳情。終態回呼包含與終態輪詢回應相同的結果欄位;某些端點也會傳送已記錄的 processing 回呼。請快速回傳成功的 HTTP 回應,並在交付延遲或回呼處理程序無法使用時保持輪詢可用以進行對帳。

閱讀回呼以了解如何建立回呼密鑰、驗證簽章及安全處理重試。