Pan

POST

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

This endpoint from PiAPI's Midjourney API expands the image towards a chosen direction while preserving original image content and using the new prompt to fill in the expanded space. The endpoint corresponds to the Pan 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

direction

string

optional

Use this parameter to assign the direction for the image expansion.

Valid values: up/down/left/right

prompt

string

optional

Use this parameter to fill in the expanded portion of the image

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": "9a472ea2************94831e7bfbed",
    "direction": "left",
    "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/pan' \
--header 'X-API-Key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "origin_task_id": "9a472ea2************94831e7bfbed",
    "direction": "left",
    "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": "73507a82*************67e45ddfc124",
    "status": "success",
    "message": ""
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

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

Outpaint

Describe