开始

重要约定

提交任务时，必须携带header Authorization: Bearer hk-替换为你的key 或者 Mj-Api-Secret: hk-替换为你的key
Midjourney接口地址 https://api.openai-hk.com
以提交Imagine任务为DEMO 点击查看快速接入

任务提交

模式接入点

混合模式(将去除) https://api.openai-hk.com
fast模式 https://api.openai-hk.com/fast
relax模式 https://api.openai-hk.com/relax
各种模式价格不一致，请控制台->购买KEY 查看价格

执行动作

接口地址:/mj/submit/action

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

json

{
  "customId": "MJ::JOB::upsample::2::3dbbd469-36af-4a0f-8f02-df6c579e7011",
  "notifyHook": "",
  "state": "",
  "taskId": "14001934816969359"
}

{
  "customId": "MJ::JOB::upsample::2::3dbbd469-36af-4a0f-8f02-df6c579e7011",
  "notifyHook": "",
  "state": "",
  "taskId": "14001934816969359"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
actionDTO	actionDTO	body	true	执行动作参数	执行动作参数
customId	动作标识		true	string
notifyHook	回调地址, 为空时使用全局notifyHook		false	string
state	自定义参数		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

响应示例:

json

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

提交Blend任务

接口地址:/mj/submit/blend

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

json

{
  "base64Array": [
    "data:image/png;base64,xxx1",
    "data:image/png;base64,xxx2"
  ],
  "dimensions": "SQUARE",
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "remix": true,
  "state": ""
}

{
  "base64Array": [
    "data:image/png;base64,xxx1",
    "data:image/png;base64,xxx2"
  ],
  "dimensions": "SQUARE",
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "remix": true,
  "state": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
blendDTO	blendDTO	body	true	Blend提交参数	Blend提交参数
base64Array	图片base64数组		true	array	string
dimensions	比例: PORTRAIT(2:3); SQUARE(1:1); LANDSCAPE(3:2),可用值:PORTRAIT,SQUARE,LANDSCAPE		false	string
instanceId	账号实例ID，指定账号执行任务		false	string
modes	账号模式，筛选账号执行任务		false	array	string
notifyHook	回调地址, 为空时使用全局notifyHook		false	string
remix	账号remix，筛选账号执行任务		false	boolean
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

响应示例:

json

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

提交图生文任务

接口地址:/mj/submit/describe

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

json

{
  "base64": "data:image/png;base64,xxx",
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "remix": true,
  "state": ""
}

{
  "base64": "data:image/png;base64,xxx",
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "remix": true,
  "state": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
describeDTO	describeDTO	body	true	Describe提交参数	Describe提交参数
base64	图片base64		true	string
instanceId	账号实例ID，指定账号执行任务		false	string
modes	账号模式，筛选账号执行任务		false	array	string
notifyHook	回调地址, 为空时使用全局notifyHook		false	string
remix	账号remix，筛选账号执行任务		false	boolean
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

响应示例:

json

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

提交Imagine任务

接口地址:/mj/submit/imagine

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

json

{
  "base64Array": [],
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "prompt": "Cat",
  "remix": true,
  "state": ""
}

{
  "base64Array": [],
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "prompt": "Cat",
  "remix": true,
  "state": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
imagineDTO	imagineDTO	body	true	Imagine提交参数	Imagine提交参数
base64Array	垫图base64数组		false	array	string
instanceId	账号实例ID，指定账号执行任务		false	string
modes	账号模式，筛选账号执行任务		false	array	string
notifyHook	回调地址, 为空时使用全局notifyHook		false	string
prompt	提示词		true	string
remix	账号remix，筛选账号执行任务		false	boolean
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

响应示例:

json

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

提交Modal

接口地址:/mj/submit/modal

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

json

{
  "maskBase64": "",
  "prompt": "",
  "taskId": "14001934816969359"
}

{
  "maskBase64": "",
  "prompt": "",
  "taskId": "14001934816969359"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	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

响应示例:

json

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

提交swap_face变脸任务

接口地址:/mj/insight-face/swap

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "sourceBase64": "data:image/png;base64,xxx1",
  "targetBase64": "data:image/png;base64,xxx2",
  "accountFilter": {
    "instanceId": ""
  },
  "notifyHook": "",
  "state": ""
}

{
  "sourceBase64": "data:image/png;base64,xxx1",
  "targetBase64": "data:image/png;base64,xxx2",
  "accountFilter": {
    "instanceId": ""
  },
  "notifyHook": "",
  "state": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	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

响应示例:

javascript

{
	"code": 0,
	"description": "",
	"result": ""
}

{
	"code": 0,
	"description": "",
	"result": ""
}

提交Shorten任务

接口地址:/mj/submit/shorten

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

json

{
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "prompt": "Cat",
  "remix": true,
  "state": ""
}

{
  "instanceId": "",
  "modes": [],
  "notifyHook": "",
  "prompt": "Cat",
  "remix": true,
  "state": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
shortenDTO	shortenDTO	body	true	Shorten提交参数	Shorten提交参数
instanceId	账号实例ID，指定账号执行任务		false	string
modes	账号模式，筛选账号执行任务		false	array	string
notifyHook	回调地址, 为空时使用全局notifyHook		false	string
prompt	提示词		true	string
remix	账号remix，筛选账号执行任务		false	boolean
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

响应示例:

json

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}

任务查询

指定ID获取任务

接口地址:/mj/task/{id}/fetch

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	任务ID	path	false	string

响应状态:

状态码	说明	schema
200	OK	任务
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
action	任务类型,可用值:IMAGINE,UPSCALE,VARIATION,ZOOM,PAN,DESCRIBE,BLEND,SHORTEN	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	string
submitTime	提交时间	integer(int64)	integer(int64)

响应示例:

json

{
	"action": "",
	"buttons": [
		{
			"customId": "",
			"emoji": "",
			"label": "",
			"style": 0,
			"type": 0
		}
	],
	"description": "",
	"failReason": "",
	"finishTime": 0,
	"id": "",
	"imageUrl": "",
	"progress": "",
	"prompt": "",
	"promptEn": "",
	"properties": {},
	"startTime": 0,
	"state": "",
	"status": "",
	"submitTime": 0
}

{
	"action": "",
	"buttons": [
		{
			"customId": "",
			"emoji": "",
			"label": "",
			"style": 0,
			"type": 0
		}
	],
	"description": "",
	"failReason": "",
	"finishTime": 0,
	"id": "",
	"imageUrl": "",
	"progress": "",
	"prompt": "",
	"promptEn": "",
	"properties": {},
	"startTime": 0,
	"state": "",
	"status": "",
	"submitTime": 0
}

获取任务图片的seed

接口地址:/mj/task/{id}/image-seed

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	任务ID	path	false	string

响应状态:

状态码	说明	schema
200	OK	Message«string»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
description	string
result	string

响应示例:

json

{
	"code": 0,
	"description": "",
	"result": ""
}

{
	"code": 0,
	"description": "",
	"result": ""
}

根据ID列表查询任务

接口地址:/mj/task/list-by-condition

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

json

{
  "ids": []
}

{
  "ids": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	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	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	string
submitTime	提交时间	integer(int64)	integer(int64)

响应示例:

json

[
	{
		"action": "",
		"buttons": [
			{
				"customId": "",
				"emoji": "",
				"label": "",
				"style": 0,
				"type": 0
			}
		],
		"description": "",
		"failReason": "",
		"finishTime": 0,
		"id": "",
		"imageUrl": "",
		"progress": "",
		"prompt": "",
		"promptEn": "",
		"properties": {},
		"startTime": 0,
		"state": "",
		"status": "",
		"submitTime": 0
	}
]

[
	{
		"action": "",
		"buttons": [
			{
				"customId": "",
				"emoji": "",
				"label": "",
				"style": 0,
				"type": 0
			}
		],
		"description": "",
		"failReason": "",
		"finishTime": 0,
		"id": "",
		"imageUrl": "",
		"progress": "",
		"prompt": "",
		"promptEn": "",
		"properties": {},
		"startTime": 0,
		"state": "",
		"status": "",
		"submitTime": 0
	}
]

开始 ​

任务提交 ​

模式接入点 ​

执行动作 ​

提交Blend任务 ​

提交图生文任务 ​

提交Imagine任务 ​

提交Modal ​

提交swap_face变脸任务 ​

提交Shorten任务 ​

任务查询 ​

指定ID获取任务 ​

获取任务图片的seed ​

根据ID列表查询任务 ​

开始

任务提交

模式接入点

执行动作

提交Blend任务

提交图生文任务

提交Imagine任务

提交Modal

提交swap_face变脸任务

提交Shorten任务

任务查询

指定ID获取任务

获取任务图片的seed

根据ID列表查询任务