共用回應模型

說明 Aether API 使用的共用回應結構描述。

JobIdResponse

所有建立非同步作業的 POST 端點皆回傳此結構。

結構描述

欄位	類型	說明
job_id	string (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_id	string (UUID)	是	作業的唯一識別碼
status	string	是	作業狀態 (Pending, Succeed, Failed)
image_urls	array[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}

相關文件

• 非同步作業生命週期 - 作業輪詢方法
• 認證 - API 認證方法