Skip to main content
HOST: https://api.deerapi.com 所有的请求都必须在 header 里加上自己的 key: 
headers = {"Authorization": "sk-hjbazhiawxxxxxxxxxx"}

​
1. 提交 Imagine（绘图）任务

​
接口信息

​
请求示例

{
    "base64Array": [],
    "notifyHook": "",
    "prompt": "Cat",
    "state": ""
}

​
请求参数

参数名称参数说明是否必须数据类型
base64Array垫图base64数组否array string
prompt提示词是string
state自定义参数否string

​
响应状态

状态码说明
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

​
响应参数

参数名称参数说明类型
code状态码: 1(提交成功), 21(已存在), 22(排队中), 4(程序内部错误)integer(int32)
description描述string
properties扩展字段object
result任务IDstring

​
响应示例

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

​
2. 执行动作

​
接口信息

  • 接口地址: https://api.deerapi.com/mj/submit/action
  • 请求方式: POST
  • 请求数据类型: application/json
  • 响应数据类型: /
  • 接口描述: 所有的关联按钮动作UPSCALE; VARIATION; REROLL; ZOOM等

​
3. 绘图变化

​
接口信息

​
请求示例

{
    "action": "UPSCALE",
    "index": 1,
    "notifyHook": "",
    "state": "",
    "taskId": "1320098173412546"
}

​
请求参数

参数名称参数说明是否必须数据类型
actionUPSCALE(放大); VARIATION(变换); REROLL(重新生成)是string
index序号(1~4), action为UPSCALE,VARIATION时必传否integer(int32)
notifyHook回调地址, 为空时使用全局notifyHook否string
state自定义参数否string
taskId任务ID是string

​
响应状态

状态码说明
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

​
响应参数

参数名称参数说明类型
code状态码: 1(提交成功), 21(已存在), 22(排队中), other(错误)integer(int32)
description描述string
properties扩展字段object
result任务IDstring

​
响应示例

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

​
4. 提交Modal (局部重绘、Zoom)

​
接口信息

  • 接口地址: https://api.deerapi.com/mj/submit/modal
  • 请求方式: POST
  • 请求数据类型: application/json
  • 响应数据类型: /
  • 接口描述: 针对midjourney有弹窗的操作，需要提交对应的数据

​
请求示例

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

​
请求参数

参数名称参数说明是否必须数据类型
maskBase64局部重绘的蒙版base64否string
prompt提示词否string
taskId任务id是string

​
响应状态

状态码说明
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

​
响应参数

参数名称参数说明类型
code状态码: 1(提交成功), 21(已存在), 22(排队中), other(错误)integer(int32)
description描述string
properties扩展字段object
result任务IDstring

​
响应示例

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

​
5. 指定 ID 获取任务

​
接口信息

​
请求参数

参数名称参数说明请求类型是否必须数据类型
id任务IDpath否string

​
响应状态

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

​
响应参数

参数名称参数说明类型
action可用值:UPSCALE,VARIATION,REROLL,DESCRIBE,BLENDstring
description任务描述string
failReason失败原因string
finishTime结束时间integer(int64)
id任务IDstring
imageUrl图片urlstring
progress任务进度string
prompt提示词string
promptEn提示词-英文string
startTime开始执行时间integer(int64)
state自定义参数string
status任务状态,可用值:SUBMITTED,IN_PROGRESS,FAILURE,SUCCESSstring
submitTime提交时间integer(int64)

​
响应示例

{
    "id": "1712310326047513",
    "action": "UPSCALE",
    "customId": "",
    "botType": "",
    "prompt": "a lovely Japan countryside --niji 6 --ar 16:9",
    "promptEn": "a lovely Japan countryside --niji 6 --ar 16:9",
    "description": "Submit success",
    "state": "",
    "submitTime": 1712310326047,
    "startTime": 1712310328336,
    "finishTime": 1712310329602,
    "imageUrl": "https://api.deerapi.com/mj/image/1712310326047513",
    "status": "SUCCESS",
    "progress": "100%",
    "failReason": "",
    "buttons": [
        {
            "customId": "MJ::JOB::upsample_v6_2x_subtle::1::125fd761-3d07-4252-8513-8a07dce51ce7::SOLO",
            "emoji": "upscale_1",
            "label": "Upscale (Subtle)",
            "type": 2,
            "style": 2
        },
        // ... 其他按钮配置
    ],
    "maskBase64": "",
    "properties": {
        "finalPrompt": "a lovely Japan countryside --niji 6 --ar 16:9",
        "finalZhPrompt": ""
    }
}