获取Midjourney任务详情(含进度)
POST
/aiapi/v1/mj/task/progress修改时间: 5 个月前
接口功能:
在Midjourney绘画任务提交后,可以通过这个结果用于跟踪Midjourney绘画的进度或者获取最终绘画结果;
注意事项:
- 请求获取Midjourney绘画任务当前详细信息
- 更多返回错误代码请看首页的错误代码描述
- state字段常量说明
状态 | 说明 |
---|---|
in_queue | 表示当前任务已经进入了等待队列,待系统调度处理 |
running | 当前绘画任务正在绘制中,可以通过current_image获取绘制过程预览图,progress会返回生成进度 |
fail | 当前任务生成失败,不会产生任何消耗 |
success | 当前任务生成成功,同时会返回最终结果图片 |
请求参数
Body 参数application/json
taskId
string
任务id
由各个提交绘画任务返回的任务id,通常是paintingSign
preview
boolean
是否获取预览图
为true则返回base64的绘画预览图,用于展现图片绘制过程
默认值:
true
imgFormat
string
结果图片格式
目前支持jpeg
和png
两种格式的图片结果返回
jpeg拥有更好的压缩比,图片大小可以明显压缩,但是可能会对图片质量造成损失
枚举值:
pngjpeg
默认值:
png
imgQuality
integer
结果图片质量
1~100的值,值越小代表对图片压缩率越大
注意,在jpeg格式下图片为有损压缩,jpeg图片quality值越小文件也会越小,请调整合适的值用于平衡您对图片大小和图片质量的需求
>= 1<= 100
默认值:
100
waitUtilEnd
boolean
等待直到任务完成再返回
可以利用此功能实现同步调用
,如果此字段为true则此接口会自动等待直到此任务执行完成(成功或者失败)后再返回
默认值:
false
示例
{
"taskId": "343740b9eb674d85ae83a4a85753f780"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
data
object
必需
progress
string
必需
当前绘画进度 ,未完成时值区间为0%-99%,完成后值为DONE
progressValue
number
进度数值
0~1表示绘图进度
>= 0<= 1
current_image
string
可选
base64格式预览图,preview为true才返回
state
string
必需
状态,in_queue:入队,running:执行中,fail:执行失败,success:成功
imgUrl
string
图片url
绘制完成结果图片url,请及时自行保存图片,此url有效期为15分钟。
如果为describe
操作则不会返回此字段
audit
integer
必需
图片审核建议;0:违规图片(此类型图片不会返回,仅会返回一个表示违规的图片url),1:图片无风险,2:图片最好是人工再进行确认是否需要展示,3:高风险图片,建议仅私密性展示,不要对外公开展示
images
array [object {2}]
图片数组
本次生成的多个图片会以数组形式返回。
如果为describe
操作则此字段返回空
descriptions
array[string]
描述列表
使用describe
操作的时候会返回一个字符串列表
示例
{
"data": {
"progress": "100%",
"progressValue": 0.1,
"current_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2w",
"state": "running",
"imgUrl": "https://imagesource.huashi6.com/test.jpg",
"audit": 1
},
"code": 0,
"success": true
}
修改于 5 个月前