跳到主内容

查询生成任务 · Get Generation Task

查询一次 文生图 任务的状态与结果。文生图为异步接口,提交后需用返回的 logId 轮询本接口,直到任务完成拿到图片地址。

接口地址

POST https://xiangcao.ai/api/get-generation-task

建议以固定间隔(如每 1–2 秒)轮询,直到 status 变为 completedfailed

鉴权

需要在请求头携带 API Key:

Authorization: Bearer <YOUR_API_KEY>

缺少或无效的 Token 会返回 401。只能查询属于自己账号的任务,查询他人任务会返回 403

请求体(JSON)

字段类型必填说明
logIdstring文生图接口返回的生成记录 ID。缺失或非字符串会返回 400

类型定义(TypeScript)

interface GetTaskRequest {
  /** 文生图接口返回的 logId */
  logId: string;
}

响应(JSON)

字段类型说明
logIdstring生成记录 ID。
statusstring任务状态:pending(生成中)/ completed(已出图)/ failed(失败)。
urlsstring[]生成的图片地址数组;completed 时非空。
createdAtnumber任务创建时间戳(毫秒)。
callbackReceivedAtnumber任务完成时间戳(毫秒),仅任务完成后返回;可用 callbackReceivedAt - createdAt 估算生成耗时。
interface GetTaskResponse {
  /** 生成记录 ID */
  logId: string;
  /** 任务状态 */
  status: "pending" | "completed" | "failed";
  /** 生成的图片地址;completed 时非空 */
  urls: string[];
  /** 任务创建时间戳(毫秒) */
  createdAt: number;
  /** 任务完成时间戳(毫秒),完成后才有 */
  callbackReceivedAt?: number;
}

示例

请求:

curl -X POST "https://xiangcao.ai/api/get-generation-task" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "logId": "log_abc123"
  }'

完成时的响应:

{
  "logId": "log_abc123",
  "status": "completed",
  "urls": [
    "https://img.xiangcao.ai/3a1b....png/public"
  ],
  "createdAt": 1751328000000,
  "callbackReceivedAt": 1751328012000
}

错误处理

出错时返回相应 HTTP 状态码及 JSON:{ "error": "..." }

状态码说明
400logId 缺失或非法(Missing or invalid 'logId')。
401未携带有效的 Bearer Token,或账号已被封禁。
403该任务不属于当前账号。
404任务不存在,或已被删除。
500服务端内部错误。