POST jobs/imagine

Midjourney /imagine command

December 2023

Request Headers
Request Body
Responses
Model
Examples
Try It

Use this endpoint to submit the Midjourney /imagine command to your Discord Midjourney channel. Results obtained as a callback via optional parameter replyUrl or by querying jobs/?jobid=jobid endpoint.

Your current Midjourney Settings and Presets will be used, log in to your Discord Midjourney account to adjust them to your liking.

It is important not to use the Midjourney account setup for API access for any purposes other than its intended use, such as executing /imagine or any other Midjourney commands manually or in conjunction with any other automation tools. The useapi.net API internally tracks the usage of the Midjourney account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly.

https://api.useapi.net/v2/jobs/imagine

Request Headers

Authorization: Bearer {API token}
Content-Type: application/json

API token is required, see Setup useapi.net for details.

Request Body

{
    "prompt": "Midjourney prompt",
    "discord": "Discord token",
    "server": "Discord server id",
    "channel": "Discord channel id",
    "maxJobs": 3,
    "replyUrl": "Place your call back URL here",
    "replyRef": "Place your reference id here"
}

prompt is required, must contain Midjourney /imagine prompt.
Maximum length 2048 characters.
discord, server, channel are optional, if not provided randomly selected available account from account/midjourney will be used. See Setup Midjourney for details.
Note You may specify the channel value alone (omitting discord and server) when you wish to use a specific account from the configured list at account/midjourney.
maxJobs is optional, if not provided value for channel account selected above will be used, if not provided defaulted to 3.
This value should be the same or less than your Midjourney subscription plan Maximum Concurrent Jobs. Currently, it should be 3 or less for Basic and Standard plans and 15 or less for Pro and Mega plans.
Important Specifying a higher number than supported by your Midjourney subscription will prevent API from functioning properly.
replyUrl is optional, if not provided value from account will be used.
Place here your callback URL. API will call the provided replyUrl once job completed or failed.
Maximum length 1024 characters.
We recommend using sites like webhook.site to test callback URL functionality.
replyRef is optional, place here your reference id which will be stored and returned along with this job response / result.
Maximum length 1024 characters.

Responses

200 OK

Use returned jobid to retrieve job status and results. content contains message generated by Midjourney reflecting current generation parameters and progress.

If you want to retrieve four separate upscaled images once job completed successfully execute seed.

{
    "jobid": "<jobid>",
    "verb": "imagine",
    "status": "started",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "prompt": "Steampunk cat",
    "discord": "<ABC…secured…xyz>",
    "channel": "<Discord channel id>",
    "server": "<Discord server id>",
    "maxJobs": 3,
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "content": "**Steampunk cat --s 750 --v 5.2** - <@Discord user id> (Waiting to start)",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 200
}

400 Bad Request

{
    "error": 
      "prompt, discord, server or channel value is missing"
      "prompt, replyRef or replyUrl is too long"
    "code": 400
}

401 Unauthorized

{
    "error": "Unauthorized",
    "code": 401
}

402 Payment Required

{
    "error": "Account has no subscription or subscription expired",
    "code": 402
}

422 Unprocessable Content

Moderated message or invalid prompt params.

{
    "error": "Action needed to continue",
    "errorDetails": "Sorry! Our AI moderators feel your prompt might be against our community standards.",
    "jobid": "<jobid>",
    "status": "moderated",
    "code": 422
}

{
    "error": "Invalid parameter",
    "errorDetails": "Unrecognized parameter(s): `size`",
    "jobid": "<jobid>",
    "status": "moderated",
    "code": 422
}

429 Too Many Requests

Wait in a loop for at least 10..30 seconds and retry again.

There are two possible cases for API response 429.
1. API query is full and can not accept new jobs/imagine requests. Size of query defined by maxJobs optional parameter. Wait in a loop for at least 10..30 seconds and retry again.
```
{
 "error": "Maximum of <maxJobs> jobs executing in parallel supported",
 "executingJobs": [
   "<jobid>",
   "<jobid>",
   "<jobid>"
 ],
 "code": 429
}
```
2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the /interactions endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response.
```
{
 "error": "Discord /interactions failed with HTTP status 429",
 "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}",
 "code": 429
}
```

503 Service Unavailable

During peak load times, the Discord Midjourney bot on rare occasions responds with the message Failed to process your command :c. You can safely resubmit the same request again.

{
    "jobid": "<jobid>",
    "verb": "imagine",
    "status": "failed",
    "error": "Discord Agent Status 503",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "prompt": "<prompt>",
    "discord": "<ABC…secured…xyz>",
    "channel": "<Discord channel id>",
    "server": "<Discord server id>",
    "maxJobs": 3,
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "content": "Failed to process your command :c",
    "messageId": "<Discord message id>",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "code": 503
}

504 Job queued

Job queued. The API will not be able to track the progress of this job, although it will still be processed by Midjourney. You may want to adjust the maxJobs number to a lower value for the next several minutes.

You should not receive this error under normal circumstances unless you have specified a maxJobs parameter higher than your Midjourney subscription supports, or if you are using the Midjourney bot outside of API interactions. On occasions when Midjourney is releasing new updates or experiencing technical issues, jobs may be paused for an extended period of time. Our API will mark all jobs running over 30 minutes as failed. When Midjourney comes back online, it will attempt to complete previously paused jobs, and you may encounter a conflict if you try to submit a new job at the same time. Although this happens very rarely, we have decided to add an extra layer to ensure such cases are detected.
```
{
    "error": "Job queued",
    "jobid": "<jobid>",
    "status": "failed",
    "code": 504
}
```

596 Pending mod message

API detected Midjourney pending moderation message and CAPTCHA account verification requests. All API calls will be halted and returned 569 response status code until you clear this field by posting to account/midjourney/channel/reset. We will also send you an email when this error ocurred. The best course of action is to log into your Discord account and acknowledge the Midjourney moderation message to prevent a potential ban on your Midjourney account.

{
    "jobid": "<jobid>",
    "verb": "imagine",
    "status": "failed",
    "created": "2023-09-09T02:04:49.667Z",
    "updated": "2023-09-09T02:04:53.490Z",
    "prompt": "Steampunk cat",
    "discord": "<ABC…secured…xyz>",
    "channel": "<Discord channel id>",
    "server": "<Discord server id>",
    "maxJobs": 3,
    "replyUrl": "https://webhook.site/abc",
    "replyRef": "<your optional reference id>",
    "messageId": "<Discord message id>",
    "timestamp": "2023-09-09T02:04:51.926000+00:00",
    "error": "Pending mod message",
    "errorDetails": "You have a pending moderation message. Please acknowledge it before using the bot further.",
    "code": 596
}

{
    "error": "Your Discord account has received a pending moderation message from Midjourney. Please address this issue and POST account/midjourney/<channel>/reset before making any new API calls.",
    "code": 596
}

Model

{ // TypeScript, all fields are optional
  jobid: string, // Use returned jobid value to retrieve job status and results
  verb: 'imagine',
  status: 'started' | 'moderated' | 'failed',
  created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC
  prompt: string,
  discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value
  channel: string,
  server: string,
  maxJobs: number,
  replyUrl: string,
  replyRef: string,
  messageId: string,
  content: string, // Contains message generated by Midjourney reflecting current generation parameters and progress
  timestamp: string,
  error: string,
  errorDetails: string,
  executingJobs: string[],
  code: number
}

Examples

curl -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer …" \
     -X POST https://api.useapi.net/v2/jobs/imagine \
     -d '{"prompt": "…", "discord": "…", "server": "…", "channel": "…"}'

const apiUrl = "https://api.useapi.net/v2/jobs/imagine"; 
const token = "API token";
const prompt = "Midjourney prompt";      
const discord = "Discord token";
const server = "Discord server id";
const channel = "Discord channel id";      
const data = { 
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json' }
};
data.body = JSON.stringify({ 
  prompt, discord, server, channel 
});
const response = await fetch(apiUrl, data);
const result = await response.json();
console.log("response", {response, result});

import requests
apiUrl = "https://api.useapi.net/v2/jobs/imagine" 
token = "API token"
prompt = "Midjourney prompt"
discord = "Discord token"
server = "Discord server id"
channel = "Discord channel id"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
body = {
    "prompt": f"{prompt}", 
    "discord": f"{discord}", 
    "server": f"{server}", 
    "channel": f"{channel}"
}
response = requests.post(apiUrl, headers=headers, json=body)
print(response, response.json())