Outpaint Endpoint - Midjourney API

Request

Header Params

X-API-Key

string

required

Insert your API Key here

Body Params application/json

model

enum<string>

required

Allowed value:

midjourney

task_type

enum<string>

required

Allowed value:

outpaint

input

object

required

origin_task_id

string

required

The task ID of the parent task.

zoom_ratio

string

optional

This parameter controls how much to zoom out on an image
Valid values:

For Midjourney Discord button "zoom out 1.5x" - use: 1.5

For Midjourney Discord button "zoom out 2x" - use: 2

For Midjourney Discord button "custom zoom" - use: (1, 2]

For Midjourney Discord button "make square" - use: 1

prompt

string

optional

This prompt for this operation.

aspect_ratio

string

optional

This parameter dictating the ouput image's aspect ratio value.

Default:

1:1

skip_prompt_check

boolean

optional

Use this parameter to skip our internal prompt check.

Default:

false

config

object

optional

webhook_config

object

optional

Webhook provides timely task notifications. Check PiAPI webhook for detail.

service_mode

enum<string>

optional

This allows users to choose whether this specific task will get processed under PAYG or HYA mode. If unspecified, then this task will get processed under whatever mode (PAYG or HYA)
the user chose on the workspace setting of your account.

public means this task will be processed under PAYG mode.

private means this task will be processed under HYA mode.

Allowed values:

publicprivate

Example

{
    "model": "midjourney",
    "task_type": "outpaint",
    "input": {
        "origin_task_id": "741ca8f8-be31-45cd-a33f-c21b8bff8ad8",
         "zoom_ratio": "2", 
          "prompt": "flying night city",
          "aspect_ratio": "16:9", 
          "skip_prompt_check": false
      },
      "config": {
          "service_mode": "",
          "webhook_config": {
              "endpoint": "",
              "secret": ""
          }
      }
  }

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'X-API-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "midjourney",
    "task_type": "outpaint",
    "input": {
        "origin_task_id": "741ca8f8-be31-45cd-a33f-c21b8bff8ad8",
         "zoom_ratio": "2", 
          "prompt": "flying night city",
          "aspect_ratio": "16:9", 
          "skip_prompt_check": false
      },
      "config": {
          "service_mode": "",
          "webhook_config": {
              "endpoint": "",
              "secret": ""
          }
      }
  }'

Responses

🟢200OK

application/json

OK - Successful response

Body

code

integer

required

data

object

required

task_id

string

required

model

string

required

task_type

string

required

status

enum<string>

required

Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged

Allowed values:

CompletedProcessingPendingFailedStaged

input

object

required

output

object

required

meta

object

required

detail

null

required

logs

array [object]

required

error

object

required

message

string

required

If you get non-null error message, here are some steps you chould follow:

Check our common error message

Retry for several times

If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.

Example

{
    "code": 200,
    "data": {
        "task_id": "672eced8-11fc-4dad-830a-688a6bf91435",
        "model": "midjourney",
        "task_type": "outpaint",
        "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"
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error