メインコンテンツへスキップ

ジョブ状態の取得

Purpose​

このエンドポイントは非同期ジョブの現在の状態と結果を照会します。ジョブID(job_id)を通じて画像生成、アップスケール、インペイント、レイヤー分離などのジョブ状態を確認できます。

Method and Path​

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

Authentication​

このエンドポイントはBearer Token認証が必要です。詳細については認証ガイドを参照してください。

必須ヘッダー:

Authorization: Bearer {your_api_key}

Request Fields​

Path Parameters​

フィールド名タイプ必須説明
job_idUUID必須照会するジョブの一意識別子 (UUID形式)

Response​

GetJobStatusResponse​

フィールド名タイプ説明
job_idUUIDジョブの一意識別子
statusstringジョブ状態。可能な値: Pending, Succeed, Failed
image_urlslist[string]完了した画像URLリスト。ジョブ成功時のみ含まれる

Status Values​

  • Pending: ジョブが進行中または待機中の状態
  • Succeed: ジョブが正常に完了
  • Failed: ジョブ処理中にエラーが発生

Error / Validation Rules​

HTTP状態コードエラー状況説明
401 Unauthorized認証失敗無効なAPIキーまたは欠落した認証ヘッダー
404 Not Foundジョブなし該当job_idに対応するジョブが見つからない
422 Unprocessable Entityjob_id形式不正job_idは有効なUUIDである必要があります

Async Job Behavior​

このエンドポイントは非同期ジョブの状態を照会するために使用されます。ジョブ作成エンドポイント(例: /image-tune/upscale)は即座にjob_idを返し、実際の処理はバックグラウンドで進行します。

ポーリング戦略:

  • ジョブ作成後job_idを受け取ったら、このエンドポイントでポーリングして状態を確認します
  • 初期状態はPendingです
  • ジョブ完了時statusがSucceedに変更され、image_urlsに結果画像URLが含まれます
  • ジョブ失敗時statusがFailedに変更されます
  • ポーリング間隔は1-2秒を推奨します

Example Request​

cURL​

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

Response Example (Success - Pending)​

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

Response Example (Success - Completed)​

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

Response Example (Failed)​

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