Inpainting - ModelsLab

curl --request POST \ --url https://modelslab.com/api/v6/images/inpaint \ --header 'Content-Type: application/json' \ --data ' { "key": "<string>", "model_id": "<string>", "init_image": "<string>", "mask_image": "<string>", "prompt": "<string>", "negative_prompt": "<string>", "width": 512, "height": 512, "samples": 1, "steps": 21, "guidance_scale": 7.5, "strength": 0.7, "scheduler": "DPMSolverMultistepScheduler", "use_karras_sigmas": "yes", "algorithm_type": "sde-dpmsolver++", "clip_skip": 2, "safety_checker": "yes", "seed": 123, "webhook": "<string>", "track_id": "<string>" } '

{ "generationTime": 123, "id": 123, "output": [ "<string>" ], "proxy_links": [ "<string>" ], "meta": {}, "nsfw_content_detected": true, "webhook_status": "<string>", "tip": "<string>" }

Body

json

{
    "key": "your_api_key",
    "model_id": "pony_realism",
    "prompt": "a cat sitting on a bench",
    "negative_prompt": null,
    "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",
    "steps": "21",
    "safety_checker": "no",
    "guidance_scale": 7.5,
    "strength": 0.7,
    "scheduler": "DPMSolverMultistepScheduler",
    "use_karras_sigmas": "yes",
    "algorithm_type": "sde-dpmsolver++",
    "clip_skip": "2",
    "seed": null,
    "webhook": null,
    "track_id": null
}

Body

application/json

key

string

required

Your API Key used for request authorization.

model_id

string

required

The ID of the Pony model to be used. Use pony_realism for the Pony Realism model.

init_image

string<uri>

required

URL of the initial image.

mask_image

string<uri>

required

URL of the mask image for inpainting.

prompt

string

A text description of what you want in the generated image.

negative_prompt

string

Items you don't want in the image.

width

integer

default:512

The width of the image in pixels. Must be between 512-1024 and divisible by 8.

Required range: 512 <= x <= 1024

height

integer

default:512

The height of the image in pixels. Must be between 512-1024 and divisible by 8.

Required range: 512 <= x <= 1024

samples

integer

default:1

The number of images to be returned in response. Maximum is 4.

Required range: x <= 4

steps

integer

default:21

Number of inference steps for inpainting.

guidance_scale

number

default:7.5

How closely to follow the prompt. Higher values = more literal interpretation.

Required range: 1 <= x <= 20

strength

number

default:0.7

Prompt strength when using the initial image. Range from 0 to 1.

Required range: 0 <= x <= 1

scheduler

string

default:DPMSolverMultistepScheduler

Scheduler to use for denoising.

use_karras_sigmas

enum<string>

default:yes

Apply Karras sigmas to the scheduler.

Available options:

yes,

no

algorithm_type

string

default:sde-dpmsolver++

Algorithm type for the scheduler.

clip_skip

integer

default:2

Number of CLIP layers to skip. Affects style interpretation.

Required range: 1 <= x <= 4

safety_checker

enum<string>

default:yes

Enable NSFW content filter.

Available options:

yes,

no

seed

integer | null

Random seed for reproducible results. Pass null for a random number.

webhook

string<uri>

URL to receive a POST API call once image generation is complete.

track_id

string

Unique ID used in webhook response to identify the request.

Response

Inpainting generation response

Option 1
Option 2
Option 3

status

enum<string>

Status of the image generation.

Available options:

success

generationTime

number

Time taken to generate the image in seconds.

integer

Unique identifier for the image generation request.

output

string<uri>[]

Array of generated image URLs.

proxy_links

string<uri>[]

Array of proxy image URLs.

Documentation Index

​Request

​Body

Body

Response

Request

Body