获取绘画任务详情
POST
/aiapi/v1/task/detail修改时间: 3 个月前
在绘画任务提交后,可以通过这个结果用于跟踪绘画的进度或者获取最终绘画结果
图片审核建议结果常量说明:
0
:违规图片(此类型图片不会返回,仅会返回一个表示违规的图片url)1
:图片无风险(可能会包含轻微性感图片)2
:图片最好是人工再进行确认是否需要展示,3
:高风险图片,建议仅私密性展示,不要对外公开展示
由于不同客户对图片合规性要求有个性化需求,建议根据您的业务形态自行参考audit值
对图片进行展示控制
state字段常量说明
状态 | 说明 |
---|---|
in_queue | 表示当前任务已经进入了等待队列,待系统调度处理 |
running | 当前绘画任务正在绘制中,可以通过current_image获取绘制过程预览图,progress会返回生成进度 |
fail | 当前任务生成失败,不会产生任何消耗 |
success | 当前任务生成成功,同时会返回最终结果图片 |
请求参数
Body 参数application/json
taskId
string
任务ID
由提交任务成功返回的任务ID,通常是paintingSign
preview
boolean
是否返回预览图
如果不需要预览图,可以传false,用于减少响应体大小
默认值:
true
imgFormat
string
结果图片格式
目前支持jpeg
和png
两种格式的图片结果返回
jpeg拥有更好的压缩比,图片大小可以明显压缩,但是可能会对图片质量造成损失
枚举值:
pngjpeg
默认值:
jpeg
imgQuality
integer
结果图片质量
1~100的值,值越小代表对图片压缩率越大
注意,在jpeg格式下图片为有损压缩,jpeg图片quality值越小文件也会越小,请调整合适的值用于平衡您对图片大小和图片质量的需求
>= 1<= 100
默认值:
100
waitUtilEnd
boolean
等待直到任务完成再返回
可以利用此功能实现同步调用
,如果此字段为true则此接口会自动等待直到此任务执行完成(成功或者失败)后再返回
默认值:
false
示例
{
"taskId": "2a0bbe954c12474890dab787a6e64e18"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
data
object
必需
state
string
任务状态
任务状态共有4种:
in_queue
任务当前已经进入队列,等待执行中running
任务当前正在执行中,请继续轮询此接口获取最新状态success
任务执行结束,并且结果为成功,可以获取任务结果fail
任务执行结束,但是结果为失败,可以获取失败原因
progress
number
任务进度
取值范围0~1.0
current_image
string
绘画预览图
用于表现绘画过程的预览图,base64格式,仅在任务没有完成的时候返回
audit
integer
图片审核结果
仅在state为success
才会返回。当生成单图的时候,单图的审核结果会直接在这里返回
imgUrl
string
单图URL
仅在state为success
才会返回。图片URL的有效期为半个小时,请获取后自行进行保存
images
array [object {2}]
本次生成的图片列表
仅在state为success
才会返回。不管是单图还是多图,都会单独在这个数组里面返回每一个图片
示例
{
"data": {
"state": "success",
"progress": 1,
"audit": 1,
"images": [
{
"imageUrl": "https://imgsource.huashi6.com/temp/13_155803.jpg",
"audit": 1
}
],
"imgUrl": "https://imgsource.huashi6.com/temp/13_155803.jpg"
},
"code": 0,
"success": true
}
修改于 3 个月前