Imagine

INFO

(We have decided to discontinue mj API in our system, and would like to introduce an anlternative. Visit Sunsetting Midjourney to learn more.)

INFO

This endpoint from GoAPI's Midjourney API generates 4 unique images in a 2x2 grid from a text description also known as prompt. This endpoint corresponds with the /imagine command from the offical Midjourney.

Mode Selection

Please use the process_mode parameter to select modes (please refrain from using the in-prompt-mode to select modes).

Below are rules about mode selection:

If the process mode is not specified, system will default to the in-prompt-mode. If the in-prompt-mode is also not specified, then the system default is relax mode. For example:

If process mode = "" and in-prompt-mode = relax ---> will use relax

If process mode = "" and in-prompt-mode = fast ---> will use fast

If process mode = "" and in-prompt-mode = unspecified ---> will use relax

Process mode overrides in-prompt-mode; for example:

If process mode = fast and in-prompt-mode = relax ---> will use fast

If process mode = relax and in-prompt-mode = fast ---> will use relax

For BYOA users, rules will apply depending on the available resource of your Midjourney account(s). For example:

Fast or turbo jobs will be routed to any accounts with available fast hours. If none is available, the job will be processed as a relax job on any accounts with relax GPU time.

Relax jobs will be routed to any accounts that is not on the Basic Plan (the $10 plan) because this plan has no relax GPU time. If none is available, then an error will be returned.

If your only Midjourney account's account setting is relax, then all the jobs processed by this account will be relax mode regardless mode selection from GoAPI. Also, when you set your Midjourney account to relax mode, we will not use it for any fast job, and this might result in wasted fast hours.

If your Midjourney account's setting is fast, then all jobs will be processed as per mode selection from GoAPI. When your Midjourney account runs out of fast hours, we will automatically change that account's setting to relax.

Note:

Endpoints such as upscale, variation, outpaint, and pan don’t support process mode. Instead, they inherit the process mode from the parent task automatically.

Request

Header Params

Body Params application/json

Example

{
    "model": "midjourney",
    "task_type": "imagine",
    "input": {
        "prompt": "flying night city",
        "aspect_ratio": "16:9",
        "process_mode": "fast",
        "skip_prompt_check": false,
        "bot_id": 0
    },
    "config": {
        "service_mode": "",
        "webhook_config": {
            "endpoint": "",
            "secret": ""
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "code": 200,
    "data": {
        "task_id": "39631ce-xxxx-xxxx-xxxx-6de760cd2053",
        "model": "midjourney",
        "task_type": "imagine",
        "status": "pending",
        "config": {
            "service_mode": "public",
            "webhook_config": {
                "endpoint": "",
                "secret": ""
            }
        },
        "input": {},
        "output": {
            "image_url": "",
            "image_urls": null,
            "temporary_image_urls": null,
            "discord_image_url": "",
            "actions": [],
            "progress": 0,
            "intermediate_image_urls": null
        },
        "meta": {},
        "detail": null,
        "logs": [],
        "error": {
            "code": 0,
            "raw_message": "",
            "message": "",
            "detail": null
        }
    },
    "message": "success"
}

Mode Selection#

Request

Request Code Samples

Responses

Mode Selection