Inpaint (🖌️ Vary (Region))

After a successful upscale (U1, U2, U3, U4). You have the option to use the 🖌️ Vary (Region) button to redraw a section of your image; also known as Inpainting.

POST

https://api.thenextleg.io/v2/button

Users have requested using GET requests with the Auth Token. You can pass any arguments in the POST request as encoded URI query parameters.

GET

https://api.thenextleg.io/v2/button?authToken=<token>&buttonMessageId=<id>&button=<button>&mask=<mask>&prompt=<prompt>

Request Body

buttonMessageId

Use the buttonMessageId returned in your webhook URL

button

Should always be 🖌️ Vary (Region)

prompt

Provide an updated prompt for the Inpaint or reuse your original prompt.

mask

Prove a mask for the section of the image you want to inpaint. You can use our tool to draw and generate your mask. The mask is a base64 encoded string.

ref (optional)

You can optionally pass ref in your command - which can be used useful when using webhooks

webhookOverride (optional)

You can optionally pass webhookOverride that will route a response to a webhook of your choosing.

Please note that using a webhook is completely optional. You are welcome to use the GET Message endpoint to retrieve responses.

var axios = require('axios');
var data = JSON.stringify({
  "button": "🖌️ Vary (Region)",
  "buttonMessageId": "your-buttonMessageId",
  "prompt": "hamsters running on a threadmill",
  "mask": "UklGRmQKAABXRUJQVlA4WAoAAAAgAAAA3wEA3wEASUNDUMgBAAAAAAHIAAAAAAQwA..."
  "ref": "",
  "webhookOverride": ""
});

var config = {
  method: 'post',
  url: 'https://api.thenextleg.io/v2/button',
  headers: { 
    'Authorization': 'Bearer <your-token>', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

200Success

Your response will return a messageId. Use the messageId at the GET Message endpoint to poll for results, or to you can wait for the result to arrive via webhook.

{
  "success": true,
  "messageId": "your-message-id",
  "createdAt": "2023-04-04T13:07:01.927Z"
}

Get your progress and retrieve a Message using GET

After receiving your messageId you can use the GET /v2/message/<messageId> in order to retrieve your progress and image.

See the GET /v2/message/<messageId> docs for more information.

Completed Response

The message you receive by using the GET Message endpoint or received via your webhook, will have the following:

buttons

A list of buttons you can use. If your slash command has produced an output that produces buttons/interactions, they will appear here

buttonRequestId

Which can be used in a POST /v2/button and in conjunction with button from the list

imageUrl

The URL for your image

imageUrls/Upscales

Instantly Upscaled Image URLS

originatingMessageId

The message ID from your original request

content

A string containing a response from (Redacted Name)

type

The type of message you are receiving

🚧 Note: You should be aware that content will also return messages from (Redacted Name) including:

ALREADY_REQUESTED_UPSCALE

You've already requested an upscale for this image

BOT_TOOK_TOO_LONG_TO_PROCESS_YOUR_COMMAND

(Redacted Name) Bot took too long to process your command

APPEAL_ACCEPTED

Your appeal has been accepted

APPEAL_REJECTED

Your appeal has been rejected

BANNED_PROMPT

You can't use this prompt

BLOCKED

This message has been blocked

BUTTON_NOT_FOUND

Button not found

FAILED_TO_PROCESS_YOUR_COMMAND

(Redacted Name) failed to process your command

FAILED_TO_REQUEST

Failed to request

IMAGE_BLOCKED

This image has been blocked

INTERNAL_ERROR

(Redacted Name) had an internal error

INVALID_LINK

Invalid link

INVALID_PARAMETER

Invalid parameter

JOB_ACTION_RESTRICTED

Job action restricted

JOB_QUEUED

Job queued

MODERATION_OUTAGE

There is a content moderator outage

NO_FAST_HOURS

You've ran out of fast hours

PLEASE_SUBSCRIBE_TO_MJ_IN_YOUR_DASHBOARD

You're not subscribed to (Redacted Name)

QUEUE_FULL

Queue full

{
    "createdAt": {
        "_nanoseconds": 215000000,
        "_seconds": 1678840347
    },
    "buttons": [
        "U1",
        "U2",
        "U3",
        "U4",
        "🔄",
        "V1",
        "V2",
        "V3",
        "V4"
    ],
    "type": "button",
    "imageUrl": "your-image-url",
    "buttonMessageId": "OtfxNzfMIKBPVE1aP4u4",
    "originatingMessageId": "your-message-id",
    "content": "your-original-prompt",
    "ref": "",
    "responseAt": "2023-04-04T13:06:01.927Z"
}

Original (Imagine -> U1): Wide view, behind the scenes, Ayutthaya large robot workshop, extra large, Fuji film, hyper-realism from 1970s Thai sci-fi movies, steam-powered aerial robot workshop army, maintenance soldiers.

The Next Leg