Midjourney API文档
Midjourney API文档
InsightFace任务提交
提交swap_face任务
/mj/insight-face/swap
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
swapFaceDTO | swapFaceDTO | body | true | SwapFace提交参数 | SwapFace提交参数 |
sourceBase64 | 人脸源图片base64 | true | string | ||
targetBase64 | 目标图片base64 | true | string | ||
accountFilter | 筛选账号执行任务,不需要筛选时设置为null或移除该参数 | false | Filter | Filter | |
instanceId | 账号实例ID | false | string | ||
notifyHook | 回调地址, 为空时使用全局notifyHook | false | string | ||
state | 自定义参数 | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Message«string» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
description | string | ||
result | string |
任务提交
执行动作
/mj/submit/action
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
actionDTO | actionDTO | body | true | 执行动作参数 | 执行动作参数 |
chooseSameChannel | 是否选择同一频道下的账号,默认只使用任务关联的账号 | false | boolean | ||
customId | 动作标识 | true | string | ||
taskId | 任务ID | true | string | ||
accountFilter | 筛选账号条件(限同一频道),不需要筛选时设置为null或移除该参数 | false | 账号筛选条件 | 账号筛选条件 | |
channelId | 频道ID | false | string | ||
instanceId | 账号实例ID | false | string | ||
modes | 账号模式 | false | array | string | |
remark | 备注包含 | false | string | ||
remix | 账号是否remix | false | boolean | ||
remixAutoConsidered | 账号过滤时,remix自动提交 视为 账号的remix为false | false | boolean | ||
notifyHook | 回调地址, 为空时使用全局notifyHook | false | string | ||
state | 自定义参数 | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | 提交结果 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 状态码: 1(提交成功), 22(排队中), other(错误) | integer(int32) | integer(int32) |
description | 描述 | string | |
properties | 扩展字段 | object | |
result | 任务ID | string |
提交Blend任务
/mj/submit/blend
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
blendDTO | blendDTO | body | true | Blend提交参数 | Blend提交参数 |
botType | bot类型,mj(默认)或niji,可用值:MID_JOURNEY,NIJI_JOURNEY | false | string | ||
base64Array | 图片base64数组 | true | array | string | |
dimensions | 比例: PORTRAIT(2:3); SQUARE(1:1); LANDSCAPE(3:2),可用值:PORTRAIT,SQUARE,LANDSCAPE | false | string | ||
accountFilter | 筛选账号执行任务,不需要筛选时设置为null或移除该参数 | false | 账号筛选条件 | 账号筛选条件 | |
channelId | 频道ID | false | string | ||
instanceId | 账号实例ID | false | string | ||
modes | 账号模式 | false | array | string | |
remark | 备注包含 | false | string | ||
remix | 账号是否remix | false | boolean | ||
remixAutoConsidered | 账号过滤时,remix自动提交 视为 账号的remix为false | false | boolean | ||
notifyHook | 回调地址, 为空时使用全局notifyHook | false | string | ||
state | 自定义参数 | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | 提交结果 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 状态码: 1(提交成功), 22(排队中), other(错误) | integer(int32) | integer(int32) |
description | 描述 | string | |
properties | 扩展字段 | object | |
result | 任务ID | string |
提交Describe任务
/mj/submit/describe
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
describeDTO | describeDTO | body | true | Describe提交参数 | Describe提交参数 |
botType | bot类型,mj(默认)或niji,可用值:MID_JOURNEY,NIJI_JOURNEY | false | string | ||
base64 | 图片base64 | true | string | ||
accountFilter | 筛选账号执行任务,不需要筛选时设置为null或移除该参数 | false | 账号筛选条件 | 账号筛选条件 | |
channelId | 频道ID | false | string | ||
instanceId | 账号实例ID | false | string | ||
modes | 账号模式 | false | array | string | |
remark | 备注包含 | false | string | ||
remix | 账号是否remix | false | boolean | ||
remixAutoConsidered | 账号过滤时,remix自动提交 视为 账号的remix为false | false | boolean | ||
notifyHook | 回调地址, 为空时使用全局notifyHook | false | string | ||
state | 自定义参数 | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | 提交结果 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 状态码: 1(提交成功), 22(排队中), other(错误) | integer(int32) | integer(int32) |
description | 描述 | string | |
properties | 扩展字段 | object | |
result | 任务ID | string |
提交Imagine任务
/mj/submit/imagine
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
imagineDTO | imagineDTO | body | true | Imagine提交参数 | Imagine提交参数 |
botType | bot类型,mj(默认)或niji,可用值:MID_JOURNEY,NIJI_JOURNEY | false | string | ||
prompt | 提 示词 | true | string | ||
base64Array | 垫图base64数组 | false | array | string | |
accountFilter | 筛选账号执行任务,不需要筛选时设置为null或移除该参数 | false | 账号筛选条件 | 账号筛选条件 | |
channelId | 频道ID | false | string | ||
instanceId | 账号实例ID | false | string | ||
modes | 账号模式 | false | array | string | |
remark | 备注包含 | false | string | ||
remix | 账号是否remix | false | boolean | ||
remixAutoConsidered | 账号过滤时,remix自动提交 视为 账号的remix为false | false | boolean | ||
notifyHook | 回调地址, 为空时使用全局notifyHook | false | string | ||
state | 自定义参数 | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | 提交结果 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 状态码: 1(提交成功), 22(排队中), other(错误) | integer(int32) | integer(int32) |
description | 描述 | string | |
properties | 扩展字段 | object | |
result | 任务ID | string |
提交Modal
/mj/submit/modal
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
modalDTO | modalDTO | body | true | Modal提交参数 | Modal提交参数 |
maskBase64 | 局部重绘的蒙版base64 | false | string | ||
prompt | 提示词 | false | string | ||
taskId | 任务ID | true | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | 提交结果 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 状态码: 1(提交成功), 22(排队中), other(错误) | integer(int32) | integer(int32) |
description | 描述 | string | |
properties | 扩展字段 | object | |
result | 任务ID | string |
提交Shorten任务
/mj/submit/shorten
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
shortenDTO | shortenDTO | body | true | Shorten提交参数 | Shorten提交参数 |
botType | bot类型,mj(默认)或niji,可用值:MID_JOURNEY,NIJI_JOURNEY | false | string | ||
prompt | 提示词 | true | string | ||
accountFilter | 筛选账号执行任务,不需要筛选时设置为null或移除该参数 | false | 账号筛选条件 | 账号筛选条件 | |
channelId | 频道ID | false | string | ||
instanceId | 账号实例ID | false | string | ||
modes | 账号模式 | false | array | string | |
remark | 备注包含 | false | string | ||
remix | 账号是否remix | false | boolean | ||
remixAutoConsidered | 账号过滤时,remix自动提交 视为 账号的remix为false | false | boolean | ||
notifyHook | 回调地址, 为空时使用全局notifyHook | false | string | ||
state | 自定义参数 | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | 提交结果 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 状态码: 1(提交成功), 22(排队中), other(错误) | integer(int32) | integer(int32) |
description | 描述 | string | |
properties | 扩展字段 | object | |
result | 任务ID | string |
任务查询
查询所有任务
/mj/task/list
GET
application/x-www-form-urlencoded
*/*
状态码 | 说明 | schema |
---|---|---|
200 | OK | 任务 |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
action | 任务类型,可用值:IMAGINE,UPSCALE,VARIATION,ZOOM,PAN,DESCRIBE,BLEND,SHORTEN,SWAP_FACE | string | |
buttons | array | 可执行按钮 | |
customId | 动作标识 | string | |
emoji | 图标 | string | |
label | 文本 | string | |
style | 样式: 2(Primary)、3(Green) | integer(int32) | |
type | 类型,系统内部使用 | integer(int32) | |
description | 任务描述 | string | |
failReason | 失败原因 | string | |
finishTime | 结束时间 | integer(int64) | integer(int64) |
id | ID | string | |
imageUrl | 图片url | string | |
progress | 任务进度 | string | |
prompt | 提示词 | string | |
promptEn | 提示词-英文 | string | |
properties | object | ||
startTime | 开始执行时间 | integer(int64) | integer(int64) |
state | 自定义参数 | string | |
status | 任务状态,可用值:NOT_START,SUBMITTED,MODAL,IN_PROGRESS,FAILURE,SUCCESS,CANCEL | string | |
submitTime | 提交时间 | integer(int64) | integer(int64) |
根据ID列表查询任务
/mj/task/list-by-condition
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
conditionDTO | conditionDTO | body | true | 任务查询参数 | 任务查询参数 |
ids | 任务ID数组 | false | array | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | 任务 |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
action | 任务类型,可用值:IMAGINE,UPSCALE,VARIATION,ZOOM,PAN,DESCRIBE,BLEND,SHORTEN,SWAP_FACE | string | |
buttons | array | 可执行按钮 | |
customId | 动作标识 | string | |
emoji | 图标 | string | |
label | 文本 | string | |
style | 样式: 2(Primary)、3(Green) | integer(int32) | |
type | 类型,系统内部使用 | integer(int32) | |
description | 任务描述 | string | |
failReason | 失败原因 | string | |
finishTime | 结束时间 | integer(int64) | integer(int64) |
id | ID | string | |
imageUrl | 图片url | string | |
progress | 任务进度 | string | |
prompt | 提示词 | string | |
promptEn | 提示词-英文 | string | |
properties | object | ||
startTime | 开始执行时间 | integer(int64) | integer(int64) |
state | 自定义参数 | string | |
status | 任务状态,可用值:NOT_START,SUBMITTED,MODAL,IN_PROGRESS,FAILURE,SUCCESS,CANCEL | string | |
submitTime | 提交时间 | integer(int64) | integer(int64) |
根据ID列表查询任务-字段displays
/mj/task/list-by-ids
POST
application/json
*/*
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
conditionDTO | conditionDTO | body | true | 任务查询参数 | 任务查询参数 |
ids | 任务ID数组 | false | array | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Map«string,object» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
分页查询任务
/mj/task/query
POST
application/json
*/*
参数名称 | 参 数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
queryDTO | queryDTO | body | true | TaskQueryDTO | TaskQueryDTO |
pageNumber | 当前页, 从0开始 | false | integer(int32) | ||
pageSize | 每页条数 | false | integer(int32) | ||
sort | 排序 | false | string | ||
action | 可用值:IMAGINE,UPSCALE,VARIATION,ZOOM,PAN,DESCRIBE,BLEND,SHORTEN,SWAP_FACE | false | string | ||
description | false | string | |||
ids | false | array | string | ||
instanceId | false | string | |||
prompt | false | string | |||
promptEn | false | string | |||
state | false | string | |||
status | 可用值:NOT_START,SUBMITTED,MODAL,IN_PROGRESS,FAILURE,SUCCESS,CANCEL | false | string | ||
statusSet | false | array | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Page«任务» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
content | array | 任务 | |
action | 任务类型,可用值:IMAGINE,UPSCALE,VARIATION,ZOOM,PAN,DESCRIBE,BLEND,SHORTEN,SWAP_FACE | string | |
buttons | array | 可执行按钮 | |
customId | 动作标识 | string | |
emoji | 图标 | string | |
label | 文本 | string | |
style | 样式: 2(Primary)、3(Green) | integer | |
type | 类型,系统内部使用 | integer | |
description | 任务描述 | string | |
failReason | 失败原因 | string | |
finishTime | 结束时间 | integer(int64) | |
id | ID | string | |
imageUrl | 图片url | string | |
progress | 任务进度 | string | |
prompt | 提示词 | string | |
promptEn | 提示词-英文 | string | |
properties | object | ||
startTime | 开始执行时间 | integer(int64) | |
state | 自定义参数 | string | |
status | 任务状态,可用值:NOT_START,SUBMITTED,MODAL,IN_PROGRESS,FAILURE,SUCCESS,CANCEL | string | |
submitTime | 提交时间 | integer(int64) | |
empty | boolean | ||
first | boolean | ||
last | boolean | ||
number | integer(int32) | integer(int32) | |
numberOfElements | integer(int32) | integer(int32) | |
pageable | Pageable | Pageable | |
offset | integer(int64) | ||
pageNumber | integer(int32) | ||
pageSize | integer(int32) | ||
paged | boolean | ||
sort | Sort | Sort | |
empty | boolean | ||
sorted | boolean | ||
unsorted | boolean | ||
unpaged | boolean | ||
size | integer(int32) | integer(int32) | |
sort | Sort | Sort | |
empty | boolean | ||
sorted | boolean | ||
unsorted | boolean | ||
totalElements | integer(int64) | integer(int64) | |
totalPages | integer(int32) | integer(int32) |
查询任务队列
/mj/task/queue
GET
application/x-www-form-urlencoded
*/*
状态码 | 说明 | schema |
---|---|---|
200 | OK | 任务 |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
action | 任务类型,可用值:IMAGINE,UPSCALE,VARIATION,ZOOM,PAN,DESCRIBE,BLEND,SHORTEN,SWAP_FACE | string | |
buttons | array | 可执行按钮 | |
customId | 动作标识 | string | |
emoji | 图标 | string | |