Inpaint

POST

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

This endpoint from PiAPI's Midjourney API alters a part of an upscaled image. This endpoint corresponds with the Vary (Region) command from the offical 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.

mask

string

required

Base64 encoded mask for the region to be modified.

prompt

string

optional

This prompt used to regenerate the selected region 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 will be passed as the x-webhook-secret field in the headers during the request. The default value is empty

Example

{
    "origin_task_id": "222fea1d***************dd1957e18dae",
    "prompt": "mirror",
    "skip_prompt_check": false,
    "mask": "UklGRuoVAABXRUJQVl****************************************************************************u5kemQMX7Up9QGQYYFzbZAAAAA",
    "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/inpaint' \
--header 'X-API-Key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "origin_task_id": "222fea1d***************dd1957e18dae",
    "prompt": "mirror",
    "skip_prompt_check": false,
    "mask": "UklGRuoVAABXRUJQVl****************************************************************************u5kemQMX7Up9QGQYYFzbZAAAAA",
    "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": "b2fb598a***************817b83714392",
    "status": "success",
    "message": ""
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

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

Variation

Outpaint