post-controlnet-inpaint-inferences
Generate new images by inpainting masked areas using ControlNet guidance from pose, depth, or edge maps for controlled AI image editing.
Instructions
Trigger a new image generation in ControlNet + Inpaint mode. The control image is used to guide the generation; it can be a pose, canny map, or similar. The mask indicates the area to inpaint in the reference image.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| originalAssets | No | If set to true, returns the original asset without transformation | |
| dryRun | No | ||
| controlEnd | No | Specifies how long the ControlNet guidance should be applied during the inference process. Only available for Flux.1-dev based models. The value represents the percentage of total inference steps where the ControlNet guidance is active. For example: - 1.0: ControlNet guidance is applied during all inference steps - 0.5: ControlNet guidance is only applied during the first half of inference steps Default values: - 0.5 for Canny modality - 0.6 for all other modalities | |
| modality | Yes | The modality associated with the control image used for the generation: it can either be an object with a combination of maximum For models of SD1.5 family: - up to 3 modalities from `canny`, `pose`, `depth`, `lines`, `seg`, `scribble`, `lineart`, `normal-map`, `illusion` - or one of the following presets: `character`, `landscape`, `city`, `interior`. For models of the SDXL family: - up to 3 modalities from `canny`, `pose`, `depth`, `seg`, `illusion`, `scribble` - or one of the following presets: `character`, `landscape`. For models of the FLUX schnell or dev families: - one modality from: `canny`, `tile`, `depth`, `blur`, `pose`, `gray`, `low-quality` Optionally, you can associate a value to these modalities or presets. The value must be within `]0.0, 1.0]`. Examples: - `canny` - `depth:0.5,pose:1.0` - `canny:0.5,depth:0.5,lines:0.3` - `landscape` - `character:0.5` - `illusion:1` Note: if you use a value that is not supported by the model family, this will result in an error. | |
| seed | No | Used to reproduce previous results. Default: randomly generated number. | |
| strength | No | Controls the noise intensity introduced to the input image, where a value of 1.0 completely erases the original image's details. Available for img2img and inpainting. (within [0.01, 1.0], default: 0.75) | |
| modelId | Yes | The model id to use for the inference | |
| scheduler | No | The scheduler to use to override the default configured for the model. See detailed documentation for more details. | |
| disableMerging | No | If set to true, the entire input image will likely change during inpainting. This results in faster inferences, but the output image will be harder to integrate if the input is just a small part of a larger image. | |
| disableModalityDetection | No | If false, the process uses the given image to detect the modality. If true (default), the process will not try to detect the modality of the given image. For example: with `pose` modality and `false` value, the process will detect the pose of people in the given image with `depth` modality and `false` value, the process will detect the depth of the given image with `scribble` modality and `true`value, the process will use the given image as a scribble ⚠️ For models of the FLUX schnell or dev families, this parameter is ignored. The modality detection is always disabled. ⚠️ | |
| imageParentId | No | Specifies the parent asset Id for the image when provided as a dataurl. | |
| baseModelId | No | The base model to use for the inference. Only Flux LoRA models can use this parameter. Allowed values are available in the model's attribute: `compliantModelIds` | |
| controlStart | No | Specifies the starting point of the ControlNet guidance during the inference process. Only available for Flux.1-dev based models. The value represents the percentage of total inference steps where the ControlNet guidance starts. For example: - 0.0: ControlNet guidance starts at the beginning of the inference steps - 0.5: ControlNet guidance starts at the middle of the inference steps | |
| height | No | The height of the generated images, must be a 8 multiple (within [64, 2048], default: 512) If model.type is `sd-xl`, `sd-xl-lora`, `sd-xl-composition` the height must be within [512, 2048] If model.type is `sd-1_5`, the height must be within [64, 1024] If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio parameter instead | |
| imageHide | No | Toggles the hidden status of the image when provided as a dataurl. | |
| mask | No | The mask as a data URL, used to determine the area of change. The mask is a binary mask made out of white and black pixels. The white area is the one that will be replaced. (example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgAAAAIACAMAAADDpiTIAAABiVBMVEUAAADw8PDCwsLExMT5+fn19fX8/Pz////+/v79/f2hoaH6+vrc3NxnZ2dDQ0P4+PhkZGTs7OzOzs6Ojo709PRiYmLd3d1paWkoKCji4uI9PT3n5+fe3t7z8/NISEiysrLg4ODk5OSYmJh/f3/u7u5lZWVRUVHS0tKIiIg+Pj7p6emXl5dUVFQYGBjKysqtra1TU1PT09M8PDwcHBzR0dHq6uoEBAQmJiZ8fHzm5ub7+/swMDCrq6uKioqpqalHR0c3NzdOTk6BgYF7e3uwsLCAgIB3d3empqaNjY06OjrW1tZhYWG0tLQgICBxcXEICAhPT0/o6OgkJCRzc3N5eXnV1dXj4+NKSkobGxtaWlpfX1/a2trBwcF2dnYlJSV9fX3Hx8eSkpJNTU1sbGyWlpYRERGCgoIMDAzPz8+MjIy4uLiTk5PNzc3X19cxMTGDg4MpKSm8vLxGRkavr69QUFAKCgoqKiq2trbt7e329vaGhobl5eVra2tZWVk4ODgzMzNcXFyurq63t7dzhmTOAAAFeElEQVR4nO3dZXMUaRQF4EBIOgkQdFncFhZfZPF1d3d3d3f95TthC6iQTE9kuk+Y93m+MpW6t8+p7mGkZ2gIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACK8MDyR784eTw9BRkj1RU70rPQuvFqmjXpeWjVPdUMn6VnokUz86+qjemhaM3obAWoqvRYtGX2/DWgFA93K8DK9GS0Yku3AlTr06PRht+6FqB6Mj0bLVjfvQCeBpRgb00BRtLD0YKaAjgFlKCuAF4ULsAKp4CyHakrgLcGC1BXAKeAAihA4cbqCnAyPR2N211XgNH0dDRup2tA4RSgcLUFOJaejsbVFuC59HQ0bltdAW5KT0fjVtcV4GB6OppXV4C30sPRvLoCHE0PR/PqCvBEejiaV1eA9Gy0QAEKV5P/WHo2WlBTgHXp2WhBTQFuSM9GCzwFKNv3ngKU7WL3ApxOz0YLXAHKNqwAZavJf0V6NlpQU4Bd6dloXpd7BLkClKImfwUogO+Glu3VuvwVYPDV5q8AA2+lAhTtVH3+CjDoeuRf3ZgekEYt61WAi+kJaVLt98JdAwbe/b3z14ABdn4u+VfVY+k5acbNc8u/qjalJ6UJd881/47t6WHpu2PzyL/yCzID56755T/llvTM9M8H88+/Y5+XhQbE2QXlP2XVg5/cfnrPmvHLtxYcG3nhu+dXp/dhfmpvCLIw4+mdmLtn+59/xzPptZirRvL3AeLrRkP5uwxcJxrL3y8MLSVP/XHr7P/QYP5VtbbdJelm/7RYduza+ebXmzdfakSj+XvrcIn4tOGYu9uQXp2O92P5u5vAUjDnt3mbkF6exi/z9X5Mb89r0QLcl16faP7uLR9X+1XP5qXXJ5u/AqT1/KZHs35J71+8bP5OAGl7svn/nd6/eNn8t6TXJ5r/4fT27Evm/1N6e6InALeVXwKC+b+c3p2h8FOA29Lbc2+0ANXe9P7FO5MtQPVN+gCULpx/VQ2nj0Dh0vl7KTgsHb/vhoSl46+cArLS6XcsTx+Dkv2QTr/jxfRBKNnT6fQ7VqUPQsneS6dfuZ9Y1IZ0+h3b0gehZHU//9eWC+mDULLwB0Iv8b+AoLHe+TQufQyKlg6/8kpgVjr9ygkgK51+Vd2ZPgRlS8dffZ4+AoVL5+9u0mHh/Hem9y9eMv0xNxLPG0k2IL08Q0PLkwXwCkBe9s2gX9PrcyJaABeBvGwBjqfXJ1sAp4A4BShc+BZxbhaf9ki2AI+n9ydbgNfT65MtwD/p9fk5WoAP0+uTPQVsTm9PtgDp5cm+H3QmvTxD0VNAenWmrIvlfzC9OpeE4h87ml6c/2XuF74svTZXBOIfOZVemqv29w6sv/79KL0y00y0m/+59L5ca0u7DUivywyrekQ2+vGhPj5VWJdelxkOdAtrbNvE5ceM960ByU2Z3UMzY1q56cj0x1xQgEG26WpA4wfWfjnrY/p0SxG/FbI0vTP1EcHDq7fWPOTtvhTgfGsr0Xf9uLHUV+klWIQ/F38deCO9A4uz2E+TH0ovwGIt7ovl6enpg4nRBefvi+EDYniBLw29lB6cvhlewNMBN4gfMOcmT9yxfe4XhInef5Hr0dmtk5NbJ799Ze36uvg3/pWek+btXdkl/jW/p0ejLbuufXYwtvvd9EwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAPfwHLuRXafg0SKQAAAAASUVORK5CYII=") | |
| controlImageId | No | The controlnet input image as an AssetId. Will be ignored if the `controlnet` parameter is provided | |
| image | No | The input image as a data URL (example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=") or the asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw") | |
| imageId | No | Deprecated: The input image as an AssetId. Prefer to use image with the asset ID instead. | |
| modelEpoch | No | The epoch of the model to use for the inference. Only available for Flux Lora Trained models. | |
| hideResults | No | If set, generated assets will be hidden and not returned in the list of images of the inference or when listing assets (default: false) | |
| maskId | No | The mask as an AssetId. Will be ignored if the `image` parameter is provided | |
| negativePrompt | No | The prompt not to guide the image generation, ignored when guidance < 1 (example: "((ugly face))") For Flux based model (not Fast-Flux): requires negativePromptStrength > 0 and active only for inference types txt2img / img2img / controlnet. | |
| intermediateImages | No | Enable or disable the intermediate images generation (default: false) | |
| concepts | No | ||
| controlImage | No | The controlnet input image as a data URL (example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=") | |
| guidance | No | Controls how closely the generated image follows the prompt. Higher values result in stronger adherence to the prompt. Default and allowed values depend on the model type: - For Flux dev models, the default is 3.5 and allowed values are within [0, 10] - For Flux pro models, the default is 3 and allowed values are within [2, 5] - For SDXL models, the default is 6 and allowed values are within [0, 20] - For SD1.5 models, the default is 7.5 and allowed values are within [0, 20] | |
| numInferenceSteps | No | The number of denoising steps for each image generation (within [1, 150], default: 30) | |
| numSamples | No | The number of images to generate (within [1, 128], default: 4) | |
| width | No | The width of the generated images, must be a 8 multiple (within [64, 2048], default: 512) If model.type is `sd-xl`, `sd-xl-lora`, `sd-xl-composition` the width must be within [512, 2048] If model.type is `sd-1_5`, the width must be within [64, 1024] If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio parameter instead | |
| negativePromptStrength | No | Only applicable for flux-dev based models for `txt2img`, `img2img`, and `controlnet` inference types. Controls the influence of the negative prompt. Default 0 means the negative prompt has no effect. Higher values increase negative prompt influence. Must be > 0 if negativePrompt is provided. | |
| prompt | Yes | Full text prompt including the model placeholder. (example: "an illustration of phoenix in a fantasy world, flying over a mountain, 8k, bokeh effect") |