当您向 Flux Kontext API 提交图像生成或编辑任务时,可以通过 callBackUrl 参数设置回调地址。任务完成后,系统会自动将结果推送到您指定的地址。
回调机制概述#
回调机制避免了您需要轮询 API 查询任务状态,系统会主动推送任务完成结果到您的服务器。
Webhook 安全性:为确保回调请求的真实性和完整性,我们强烈建议您实现 webhook 签名验证。请参阅我们的 Webhook 校验指南 了解详细实现步骤。 回调时机#
回调方式#
回调请求格式#
任务完成后,系统会向您的 callBackUrl 发送 POST 请求,格式如下:{
"code": 200,
"msg": "BFL 图像生成成功。",
"data": {
"taskId": "task12345",
"info": {
"originImageUrl": "https://example.com/original.jpg",
"resultImageUrl": "https://example.com/result.jpg"
}
}
}
状态码说明#
参数说明#
| 参数 | 类型 | 必需 | 说明 |
|---|
code | integer | 是 | 回调状态码,表示任务处理结果 |
msg | string | 是 | 状态消息,提供详细的状态描述 |
data.taskId | string | 是 | 任务 ID,与您提交任务时返回的 taskId 一致 |
data.info.originImageUrl | string | 否 | 原始图像 URL,有效期为 10 分钟。仅在成功时存在 |
data.info.resultImageUrl | string | 否 | 生成图像在我们服务器上的 URL。仅在成功时存在 |
状态码详情#
| 状态码 | 说明 |
|---|
| 200 | 成功 - 图像生成成功 |
| 400 | 失败 - 您的提示词被网站标记为违反内容政策 |
| 500 | 失败 - 内部错误,请稍后重试 |
| 501 | 失败 - 图像生成任务失败 |
回调接收示例#
最佳实践#
1.
使用 HTTPS: 确保回调 URL 使用 HTTPS 协议,保证数据传输安全
3.
幂等处理: 同一个 taskId 可能收到多次回调,确保处理逻辑是幂等的
4.
快速响应: 回调处理应尽快返回 200 状态码,避免超时
5.
异步处理: 复杂的业务逻辑应异步处理,避免阻塞回调响应
6.
及时下载: 原始图像 URL 只有 10 分钟有效期,收到成功回调后应及时下载
原始图像 URL 10 分钟后过期 - 收到回调后请及时下载
请确保回调处理逻辑的稳定性,避免因异常导致回调失败
需要处理多种错误状态码(400, 500, 501),实现完整的错误处理
故障排查#
替代方案#
轮询查询结果
使用获取图像详情接口定期查询任务状态,建议每 30 秒查询一次。