Skip to main content

Inpainting Endpoint

Overview​

This endpoint generates and returns an image from an image and a mask passed with their URLs in the request.

Together with the image and the mask you can add your description of the desired result by passing prompt and negative prompt.

Inpainting endpoint result

Request​

--request POST 'https://modelslab.com/api/v6/realtime/inpaint' \

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

Watch the how-to video to see it in action.

Attributes​

ParameterDescription
keyYour API Key used for request authorization
promptText prompt with description of the things you want in the image to be generated
negative_promptItems you don't want in the image
init_imageLink to the Initial Image
mask_imageLink to the mask image for inpainting
widthMax Height: Width: 1024x1024
heightMax Height: Width: 1024x1024
samplesNumber of images to be returned in response. The maximum value is 4.
enhance_promptEnhance prompts for better results; options: true/false
safety_checkerA checker for NSFW images. If such an image is detected, it will be replaced by a blank image.
strengthPrompt strength when using init image. 1.0 corresponds to full destruction of information in the init image.
instant_responsequeue response instantly before processing finishes instead of waiting a minimum amount of time default: false, options: true or false
base64Get response as base64 string, default: false, options: true or false
seedSeed is used to reproduce results, same seed will give you same image in return again. Pass null for a random number.
webhookSet an URL to get a POST API call once the image generation is complete.
track_idThis ID is returned in the response to the webhook API call. This will be used to identify the webhook request.

Example​

Body​

Body
{
  "key": "",
  "prompt": "a cat sitting on a bench",
  "negative_prompt": "bad quality",
  "init_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo.png",
  "mask_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo_mask.png",
  "width": "512",
  "height": "512",
  "samples": 1,
  "safety_checker": false,
  "strength": 0.7,
  "base64": false,
  "seed": null,
  "webhook": null,
  "track_id": null
}

Request​

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

var raw = JSON.stringify({
  "key": "",
  "prompt": "a cat sitting on a bench",
  "negative_prompt": "bad quality",
  "init_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo.png",
  "mask_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo_mask.png",
  "width": "512",
  "height": "512",
  "samples": 1,
  "safety_checker": false,
  "strength": 0.7,
  "base64": false,
  "seed": null,
  "webhook": null,
  "track_id": null
});

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

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

Response​

{
  "status": "success",
  "generationTime": 1.9110066890716553,
  "id": 12384052,
  "output": [
    "https://modelslab-bom.s3.amazonaws.com/modelslab/9b621d36-1d00-4374-bdb3-76bff56a7971-0.jpg"
  ],
  "meta": {
    "H": 512,
    "W": 512,
    "file_prefix": "e67183ee-73c1-45c4-84e7-0dec6f657d33",
    "init_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo.png",
    "mask_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo_mask.png",
    "n_samples": 1,
    "negative_prompt": " ((out of frame)), ((extra fingers)), mutated hands, ((poorly drawn hands)), ((poorly drawn face)), (((mutation))), (((deformed))), (((tiling))), ((naked)), ((tile)), ((fleshpile)), ((ugly)), (((abstract))), blurry, ((bad anatomy)), ((bad proportions)), ((extra limbs)), cloned face, glitchy, ((extra breasts)), ((double torso)), ((extra arms)), ((extra hands)), ((mangled fingers)), ((missing breasts)), (missing lips), ((ugly face)), ((fat)), ((extra legs))",
    "outdir": "out",
    "prompt": "a cat sitting on a bench DSLR photography, sharp focus, Unreal Engine 5, Octane Render, Redshift, ((cinematic lighting)), f/1.4, ISO 200, 1/160s, 8K, RAW, unedited, symmetrical balance, in-frame",
    "safetychecker": "no",
    "seed": 3163825381,
    "steps": 20,
    "strength": 0.7
  }
}