Midjorney Calling Best Practices
headers = {"Authorization": "sk-hjbazhiawxxxxxxxxxx"}1. Submit an Imagine (drawing) task
API Information
Request Example
{
"base64Array": [],
"notifyHook": "",
"prompt": "Cat",
"state": ""
}Request Parameters
| Parameter Name | Parameter Description | Request Type | Required | Data Type |
|---|---|---|---|---|
| id | Task ID | path | no | string |
Response status
| Status code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Response parameters
| Parameter name | Parameter description | Type |
|---|---|---|
| code | Status code: 1 (Submission successful), 21 (Already exists), 22 (Queued), 4 (Internal program error) | integer (int32) |
| description | Description | string |
| properties | Extension fields | object |
| result | Task ID | string |
Response example
{
"code": 1,
"description": "Submission successful",
"properties": {},
"result": 1320098173412546
}2. Executing an Action
API Information
3. Drawing Changes
API Information
Request Example
{
"action": "UPSCALE",
"index": 1,
"notifyHook": "",
"state": "",
"taskId": "1320098173412546"
}Request Parameters
| Parameter Name | Parameter Description | Required | Data Type |
|---|---|---|---|
| action | UPSCALE (upscale); VARIATION (transform); REROLL (regenerate) | Yes | string |
| index | Sequence number (1-4), required when action is UPSCALE and VARIATION | No | integer (int32) |
| notifyHook | Callback address, if left blank, uses the global notifyHook | No | string |
| state | Custom Parameters | No | string |
| taskId | Task ID | Yes | string |
Response Status
| Status Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Response Parameters
| Parameter Name | Parameter Description | Type |
|---|---|---|
| code | Status Code: 1 (Submission Successful), 21 (Already Exists), 22 (Queued), other (Error) | integer (int32) |
| description | Description | string |
| properties | Extension Fields | object |
| result | Task ID | string |
Response Example
{
"code": 1,
"description": "Submission Successful",
"properties": {},
"result": 1320098173412546
}4. Submit Modal (Partial Redraw, Zoom)
API Information
Request Example
{
"maskBase64": "",
"prompt": "",
"taskId": "14001934816969359"
}Request Parameters
| Parameter Name | Parameter Description | Required | Data Type |
|---|---|---|---|
| maskBase64 | Base64 mask for partial redraw | No | string |
| prompt | Prompt | No | string |
| taskId | Task ID | yes | string |
Response Status
| Status Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Response Parameters
| Parameter Name | Parameter Description | Type |
|---|---|---|
| code | Status Code: 1 (Submission Successful), 21 (Already Exists), 22 (Queued), other (Error) | integer (int32) |
| description | Description | string |
| properties | Extension Fields | object |
| result | Task ID | string |
Response Example
{
"code": 1,
"description": "Submission Successful",
"properties": {},
"result": 1320098173412546
}5. Get a task by specifying its ID
API Information
Request Parameters
| Parameter Name | Parameter Description | Request Type | Required | Data Type |
|---|---|---|---|---|
| id | Task ID | path | no | string |
Response Status
| Status Code | Description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Response Parameters
| Parameter Name | Parameter Description | Type |
|---|---|---|
| action | Available values: UPSCALE, VARIATION, REROLL, DESCRIBE, BLEND | string |
| description | Task description | string |
| failReason | Failure reason | string |
| finishTime | End time | integer (int64) |
| id | Task ID | string |
| imageUrl | Image URL | string |
| progress | Task progress | string |
| prompt | Prompt word | string |
| promptEn | Prompt word (English) | string |
| startTime | Start execution time | integer (int64) |
| state | Custom parameter | string |
| status | Task status, available values: SUBMITTED, IN_PROGRESS, FAILURE, SUCCESS | string |
| submitTime | Submission time | integer (int64) |
Response Example
{
"id": "1712310326047513",
"action": "UPSCALE",
"customId": "",
"botType": "",
"prompt": "a lovely Japanese countryside --niji 6 --ar 16:9",
"promptEn": "a lovely Japanese countryside --niji 6 --ar 16:9",
"description": "Submit success",
"state": "",
"submitTime": 1712310326047,
"startTime": 1712310328336,
"finishTime": 1712310329602,
"imageUrl": "https://api.elkapi.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
},
// ... other button configurations
],
"maskBase64": "",
"properties": {
"finalPrompt": "a lovely Japan countryside --niji 6 --ar 16:9",
"finalZhPrompt": ""
}
}