跳至主要內容

GET /job/{job_id}

用途​

此端點用於查詢非同步作業的目前狀態與結果。可透過作業 ID (job_id) 確認影像生成、特效、提升品質、重新繪製、移除背景、裝備變體、精靈生成等作業的狀態。

方法與路徑​

  • HTTP Method: GET
  • Path: /public/v1/job/{job_id}

認證​

此端點需要 Bearer Token 認證。詳細資訊請參閱認證指南。

必要標頭：

Authorization: Bearer {your_api_key}

請求欄位​

路徑參數​

欄位名類型必填說明
job_idUUID必填要查詢的作業唯一識別碼 (UUID 格式)

回應​

GetJobStatusResponse​

欄位名類型說明
job_idUUID作業的唯一識別碼
statusstring作業狀態。可能的值：Pending, Succeed, Failed
image_urlslist[string]已完成影像的 URL 清單。僅於作業成功時包含

狀態值​

  • Pending: 作業進行中或等待中的狀態
  • Succeed: 作業已成功完成
  • Failed: 作業處理時發生錯誤

錯誤 / 驗證規則​

HTTP 狀態碼錯誤情境說明
401 Unauthorized認證失敗無效的 API 金鑰或遺漏的認證標頭
404 Not Found作業不存在找不到該 job_id 對應的作業
422 Unprocessable Entityjob_id 格式無效job_id 必須是有效的 UUID

非同步作業行為​

此端點用於查詢非同步作業的狀態。作業建立端點（例如 /image-tune/upscale）會立即回傳 job_id，實際處理於背景進行。

輪詢策略：

  • 作業建立後收到 job_id，使用此端點輪詢確認狀態
  • 初始狀態為 Pending
  • 作業完成時 status 變更為 Succeed，且 image_urls 包含結果影像 URL
  • 作業失敗時 status 變更為 Failed
  • 建議輪詢間隔為 1-2 秒

請求範例​

cURL​

curl -X GET "https://api.aetherforgeai.com/public/v1/job/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"

回應範例 (成功 - Pending)​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Pending",
  "image_urls": []
}

回應範例 (成功 - 已完成)​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Succeed",
  "image_urls": ["https://cdn.aetherforgeai.com/images/generated_abc123.png"]
}

回應範例 (失敗)​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Failed",
  "image_urls": []
}