Outpaint

POST

https://api.piapi.ai/mj/v2/outpaint

This endpoint from PiAPI's Midjourney API extends the canvas of an upscaled image beyond the its original size while retaining the details of the original image. This endpoint corresponds to the Zoom Out tool from the official Midjourney.

Request

Header Params

X-API-Key

string

required

Insert your API Key here

Example:

Body Params application/json

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

aspect_ratio

string

optional

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

prompt

string

optional

This prompt for this operation.

skip_prompt_check

boolean

optional

Use this parameter to skip our internal prompt check. Default value: False.

webhook_endpoint

string

optional

Task notifications will be sent to the indicated address. The acceptable address can either be a domain or port 443.

webhook_secret

string

optional

This value will be passed as the x-webhook-secret field in the headers as part of the response.

Example

{
    "origin_task_id": "ba9e9dc2************90f6134ca837",
    "zoom_ratio": "2",
    "aspect_ratio": "16:9",
    "prompt": "a cute dog with a sunglasses",
    "skip_prompt_check": false,
    "webhook_endpoint": "",
    "webhook_secret": ""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.piapi.ai/mj/v2/outpaint' \
--header 'X-API-Key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "origin_task_id": "ba9e9dc2************90f6134ca837",
    "zoom_ratio": "2",
    "aspect_ratio": "16:9",
    "prompt": "a cute dog with a sunglasses",
    "skip_prompt_check": false,
    "webhook_endpoint": "",
    "webhook_secret": ""
}'

Responses

🟢200OK

application/json

OK - Successful response

Body

task_id

string

optional

status

string

optional

message

string

optional

Example

{
    "task_id": "2f6c6326***************793881539f2c",
    "status": "success",
    "message": ""
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Modified at 2024-09-24 02:23:40

Inpaint

Pan