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

共有レスポンスモデル

Aether APIで使用する共有レスポンススキーマを説明します。

JobIdResponse​

非同期ジョブを作成するすべてのPOSTエンドポイントで返されます。

スキーマ​

フィールドタイプ説明
job_idstring (UUID)作成されたジョブの一意識別子

例​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

使用エンドポイント​

  • POST /public/v1/generate/image
  • POST /public/v1/generate/effect/v1
  • POST /public/v1/generate/effect/v2
  • POST /public/v1/image-tune/upscale
  • POST /public/v1/image-tune/inpaint/v1
  • POST /public/v1/image-tune/inpaint/v2
  • POST /public/v1/image-tune/remove-background
  • POST /public/v1/image-tune/equip-variation
  • POST /public/v1/sprite/lite
  • POST /public/v1/sprite/plus
  • POST /public/v1/sprite/zenith
  • POST /public/v1/sprite/pulsar

GetJobStatusResponse​

ジョブ状態照会エンドポイントで返されます。

スキーマ​

フィールドタイプ必須説明
job_idstring (UUID)はいジョブの一意識別子
statusstringはいジョブ状態 (Pending, Succeed, Failed)
image_urlsarray[string]いいえ完了した画像URLリスト (Succeed状態でのみ提供)

状態別レスポンス例​

Pending​

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

Succeed​

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

Failed​

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

使用エンドポイント​

  • GET /public/v1/job/{job_id}

関連ドキュメント​