Outpainting Endpoint

Overview

This endpoint helps to outpaint by expanding the giving image

Request

--request POST 'https://modelslab.com/api/v6/image_editing/outpaint' \

Make a POST request to https://modelslab.com/api/v6/image_editing/outpaint endpoint and pass the required parameters as a request body to the endpoint.

Body Attributes

Parameter	Description	Values
key	Your API Key used for request authorization	key
prompt	Text prompt with a description of the things you want in the image to be generated	string
negative_prompt	Items you don't want in the image	string
image	Link or provide valid base64 data which follows the format `data:image/jpeg;base64,{your_base64_string}` to the image you want your generations to resemble	URL or base64 string
width	Max Height: Width: 1024x1024	The maximum is 1024 pixels
height	Max Height: Width: 1024x1024	The maximum is 1024 pixels
walk_type	List of values from `left`, `right`, `up`, `down`, and `backward`. For example, if you want to pan to the right for a few steps and then zoom out, you must provide: `["right", "right", "backward"]`	A list of values from `left`, `right`, `up`, `down`, `backward`
width_translation_per_step	The distance (in pixels) to translate the image on the x-axis while outpainting. Applies to walk types of `left`, `right`, and `backward`. Default: 32px	The default is 32 pixels
height_translation_per_step	The distance (in pixels) to translate the image on the y-axis while outpainting. Applies to walk types of `up`, `down`, and `backward`. Default: 32px	The default is 32 pixels
translation_factor	The factor by which to translate the image on the x-axis and y-axis while outpainting. The calculated width translation per step is `translation_factor * width`, and similar for height. Provide either `translation_factor` or both `height_translation_per_step` and `width_translation_per_step`. If all three are provided, then `translation_factor` is ignored. Default: 0.1	0.1 (0-1)
num_inference_steps	Number of denoising steps. Default: 20. Min: 1, Max: 50	The minimum is 1, and the maximum is 50. The default is 20
num_interpolation_steps	Number of filler frames to generate between two outpaint walk directions. Default: 60. Max: 120	The maximum is 120. The default is 60
as_video	Whether to return the outpainting as a video or image. Should be `true` or `false`. If `false`, the generated image will be the final result generated without any intermediate outpaint steps generated using `walk_type`	`TRUE` or `FALSE`
fps	FPS of the generated video. This requires `as_video` to be set to `true`. Default: 120	The default is 120. (desired fps)
base64	If provided image is in base64 format or if you want your generated images as a base64 string, must be set to `true`. Default: `false`	`TRUE` or `FALSE` (default: `FALSE`)
seed	Seed is used to reproduce results, same seed will give you the same image in return again. Pass null for a random number	Integral value
samples	Number of images to be returned in response. The maximum value is 4	The maximum is 4
webhook	Set a URL to get a POST API call once the image generation is complete	URL
track_id	This ID is returned in the response to the webhook API call. This will be used to identify the webhook request	Integral value

Example

Body

Body
{
    "key":"",
    "seed":12345,
    "width":512,
    "height":512,
    "prompt":"a majestic cat house, lush greenery, filled with plants, high quality, cartoonish, realistic, 4k",
    "image":"https://i.ibb.co/wp0w7nt/1-d212fe65-f95c-4bbe-b275-99f0dedd901a.png",
    "negative_prompt":"dull background, text, characters, symbols, unrealistic, repetitive background, boring background, bad, low quality, black background",
    "height_translation_per_step": 64,
    "width_translation_per_step":64,
    "num_inference_steps": 15,
    "as_video":false,
    "num_interpolation_steps": 32,
    "walk_type":["back", "back", "left","left","up", "up"],
    "webhook": null,
    "track_id": null 
}

Request

JS
PHP
NODE
PYTHON
JAVA

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    "key":"",
    "seed":12345,
    "width":512,
    "height":512,
    "prompt":"a majestic cat house, lush greenery, filled with plants, high quality, cartoonish, realistic, 4k",
    "image":"https://i.ibb.co/wp0w7nt/1-d212fe65-f95c-4bbe-b275-99f0dedd901a.png",
    "negative_prompt":"dull background, text, characters, symbols, unrealistic, repetitive background, boring background, bad, low quality, black background",
    "height_translation_per_step": 64,
    "width_translation_per_step":64,
    "num_inference_steps": 15,
    "as_video":false,
    "num_interpolation_steps": 32,
    "walk_type":["back", "back", "left","left","up", "up"],
    "webhook": null,
    "track_id": null  
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://modelslab.com/api/v6/image_editing/outpaint", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

<?php

$payload = [
    "key" => "",
    "seed" => 12345,
    "width" => 512,
    "height" => 512,
    "prompt" => "a majestic cat house, lush greenery, filled with plants, high quality, cartoonish, realistic, 4k",
    "image" => "https://i.ibb.co/wp0w7nt/1-d212fe65-f95c-4bbe-b275-99f0dedd901a.png",
    "negative_prompt" => "dull background, text, characters, symbols, unrealistic, repetitive background, boring background, bad, low quality, black background",
    "height_translation_per_step" => 64,
    "width_translation_per_step" => 64,
    "num_inference_steps" => 15,
    "as_video" => false,
    "num_interpolation_steps" => 32,
    "walk_type" => ["back", "back", "left","left","up", "up"],
    "webhook" => null,
    "track_id" => null 
];

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://modelslab.com/api/v6/image_editing/outpaint',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://modelslab.com/api/v6/image_editing/outpaint',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "key":"",
    "seed":12345,
    "width":512,
    "height":512,
    "prompt":"a majestic cat house, lush greenery, filled with plants, high quality, cartoonish, realistic, 4k",
    "image":"https://i.ibb.co/wp0w7nt/1-d212fe65-f95c-4bbe-b275-99f0dedd901a.png",
    "negative_prompt":"dull background, text, characters, symbols, unrealistic, repetitive background, boring background, bad, low quality, black background",
    "height_translation_per_step": 64,
    "width_translation_per_step":64,
    "num_inference_steps": 15,
    "as_video":false,
    "num_interpolation_steps": 32,
    "walk_type":["back", "back", "left","left","up", "up"],
    "webhook": null,
    "track_id": null 
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "https://modelslab.com/api/v6/image_editing/outpaint"

payload = json.dumps({
    "key":"",
    "seed":12345,
    "width":512,
    "height":512,
    "prompt":"a majestic cat house, lush greenery, filled with plants, high quality, cartoonish, realistic, 4k",
     "image":"https://i.ibb.co/wp0w7nt/1-d212fe65-f95c-4bbe-b275-99f0dedd901a.png",
    "negative_prompt":"dull background, text, characters, symbols, unrealistic, repetitive background, boring background, bad, low quality, black background",
    "height_translation_per_step": 64,
    "width_translation_per_step":64,
    "num_inference_steps": 15,
    "as_video":False,
    "num_interpolation_steps": 32,
    "walk_type":["back", "back", "left","left","up", "up"],
    "webhook": None,
    "track_id": None 
})

headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

       OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\n    \"key\":\"\",\n    \"seed\":12345,\n    \"width\":512,\n    \"height\":512,\n    \"prompt\":\"a majestic cat house, lush greenery, filled with plants, high quality, cartoonish, realistic, 4k\",\n     \"image\":\"https://i.ibb.co/wp0w7nt/1-d212fe65-f95c-4bbe-b275-99f0dedd901a.png\",\n    \"negative_prompt\":\"dull background, text, characters, symbols, unrealistic, repetitive background, boring background, bad, low quality, black background\",\n   \n    \"height_translation_per_step\": 64,\n    \"width_translation_per_step\":64,\n    \"num_inference_steps\": 15,\n    \"as_video\":\"false\",\n    \"num_interpolation_steps\": 32,\n    \"walk_type\":[\"back\", \"back\", \"left\",\"left\",\"up\", \"up\"],\n    \"webhook\": null,\n    \"track_id\": null \n}");
    Request request = new Request.Builder()
      .url("https://modelslab.com/api/v6/image_editing/outpaint")
      .method("POST", body)
      .addHeader("Content-Type", "application/json")
      .build();
    Response response = client.newCall(request).execute();

Response

Example Response

{
    "status": "success",
    "generationTime": 6.230603456497192,
    "id": 663,
    "output": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/47b84646-fd81-4aaf-83fd-a25506b3d8d6.png"
    ],
    "proxy_links": [
        "https://cdn2.stablediffusionapi.com/generations/47b84646-fd81-4aaf-83fd-a25506b3d8d6.png"
    ],
    "meta": {
        "as_video": "no",
        "file_prefix": "47b84646-fd81-4aaf-83fd-a25506b3d8d6",
        "fps": 120,
        "guidance_scale": 8,
        "height": 512,
        "height_translation_per_step": 64,
        "image": "https://i.ibb.co/wp0w7nt/1-d212fe65-f95c-4bbe-b275-99f0dedd901a.png",
        "n_samples": 1,
        "negative_prompt": "dull background, text, characters, symbols, unrealistic, repetitive background, boring background, bad, low quality, black background",
        "num_inference_steps": 15,
        "num_interpolation_steps": 60,
        "outdir": "out",
        "prompt": "a majestic cat house, lush greenery, filled with plants, high quality, cartoonish, realistic, 4k",
        "seed": 12345,
        "temp": "no",
        "translation_factor": null,
        "walk_type": [],
        "width": 512,
        "width_translation_per_step": 64
    }
}

Overview​

Request​

Body Attributes​

Example​

Body​

Request​

Response​

Overview

Request

Body Attributes

Example

Body

Request

Response