共享响应模型

介绍 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 认证方法