跳到主要内容

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": []
}