Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.
- Node.js
- Python
- Elixir
- HTTP
- Cog
- Docker
Input schema
The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.
| Field | Type | Default value | Description |
|---|---|---|---|
| generation_type | string (enum) | img2img Options: img2img, postprocess | Generation mode |
| clip_stop_at_last_layers | integer | 2 Min: 1 Max: 12 | Clip skip |
| upload_lora | string | Upload LoRA | |
| prompt | string | Prompt | |
| negative_prompt | string | (deformed, distorted, disfigured:1.3), (naked, nude:1.5), poorly drawn, bad anatomy, wrong anatomy, extra limb, missing limb, floating limbs, (mutated hands and fingers:1.4), disconnected limbs, mutation, mutated, ugly, disgusting, blurry, amputation | Negative prompt |
| image | string | Input image | |
| image_mask | string | Mask | |
| mask_blur | integer | 4 | Mask blur |
| resize_mode | string (enum) | Just resize Options: Just resize, Resize and fill | Resize mode |
| inpainting_fill | string (enum) | Original Options: Fill, Original, Latent noise | Masked content |
| inpaint_full_res | string (enum) | Whole picture Options: Whole picture, Only masked | Inpaint area |
| inpaint_full_res_padding | integer | 32 | Only masked padding, pixels |
| cfg_scale | number | 7 | CFG scale |
| denoising_strength | number | 0.75 | [HR] Denoising strength |
| seed | integer | Seed. Leave blank for random generation | |
| width | integer | 512 | Width |
| height | integer | 512 | Height |
| num_outputs | integer | 1 Min: 1 Max: 4 | Batch size [Doesn't work in postprocess mode]. |
| sampler | string (enum) | Euler a Options: DPM++ 2M Karras, DPM++ SDE Karras, DPM++ 2M SDE Exponential, DPM++ 2M SDE Karras, Euler a, Euler, LMS, Heun, DPM2, DPM2 a, DPM++ 2S a, DPM++ SDE, DPM++ 2M SDE, DPM++ 2M SDE Heun Karras, DPM++ 2M SDE Heun Exponential, DPM++ 3M SDE, DPM++ 3M SDE Karras, DPM++ 3M SDE Exponential, DPM fast, DPM adaptive, LMS Karras, DPM2 Karras, DPM2 a Karras, DPM++ 2S a Karras, Restart, DDIM, PLMS, UniPC | Sampling method |
| sampler_steps | integer | 20 Min: 1 Max: 50 | Sampling steps [Doesn't work in postprocess mode]. |
| ad_enabled | boolean | False | [adetailer] Enable |
| ad_model | string (enum) | face_yolov8s Options: face_yolov8n, face_yolov8s, hand_yolov8n, person_yolov8n-seg, person_yolov8s-seg, mediapipe_face_full, mediapipe_face_short, mediapipe_face_mesh, mediapipe_face_mesh_eyes_only, deepfashion2_yolov8s-seg, Без модели | [adetailer] ADetailer model |
| ad_prompt | string | [adetailer] ADetailer prompt | |
| ad_negative_prompt | string | [adetailer] ADetailer negative prompt | |
| ad_use_sampler | boolean | True | [adetailer] Use separate sampler |
| ad_sampler | string (enum) | Euler a Options: DPM++ 2M Karras, DPM++ SDE Karras, DPM++ 2M SDE Exponential, DPM++ 2M SDE Karras, Euler a, Euler, LMS, Heun, DPM2, DPM2 a, DPM++ 2S a, DPM++ SDE, DPM++ 2M SDE, DPM++ 2M SDE Heun Karras, DPM++ 2M SDE Heun Exponential, DPM++ 3M SDE, DPM++ 3M SDE Karras, DPM++ 3M SDE Exponential, DPM fast, DPM adaptive, LMS Karras, DPM2 Karras, DPM2 a Karras, DPM++ 2S a Karras, Restart, DDIM, PLMS, UniPC | [adetailer] ADetailer sampler |
| ad_confidence | number | 0.3 | [adetailer] Detection model confidence threshold |
| ad_dilate_erode | integer | 4 | [adetailer] Mask erosion (-) / dilation (+) |
| ad_mask_blur | integer | 4 | [adetailer] Inpaint mask blur |
| ad_mask_merge_mode | string (enum) | None Options: None, Merge, Merge and Invert | [adetailer] Mask merge mode |
| ad_denoising_strength | number | 0.4 | [adetailer] Inpaint denoising strength |
| ad_inpaint_only_masked | boolean | True | [adetailer] Inpaint only masked |
| ad_inpaint_only_masked_padding | integer | 32 | [adetailer] Inpaint only masked padding, pixels |
| ad_use_inpaint_width_height | boolean | False | [adetailer] Use separate width/height |
| ad_inpaint_width | integer | 512 | [adetailer] Inpaint width |
| ad_inpaint_height | integer | 512 | [adetailer] Inpaint height |
{ "type": "object", "title": "Input", "properties": { "seed": { "type": "integer", "title": "Seed", "x-order": 14, "description": "Seed. Leave blank for random generation" }, "image": { "type": "string", "title": "Image", "format": "uri", "x-order": 5, "description": "Input image" }, "width": { "type": "integer", "title": "Width", "default": 512, "x-order": 15, "description": "Width" }, "height": { "type": "integer", "title": "Height", "default": 512, "x-order": 16, "description": "Height" }, "prompt": { "type": "string", "title": "Prompt", "default": "", "x-order": 3, "description": "Prompt" }, "sampler": { "enum": [ "DPM++ 2M Karras", "DPM++ SDE Karras", "DPM++ 2M SDE Exponential", "DPM++ 2M SDE Karras", "Euler a", "Euler", "LMS", "Heun", "DPM2", "DPM2 a", "DPM++ 2S a", "DPM++ SDE", "DPM++ 2M SDE", "DPM++ 2M SDE Heun Karras", "DPM++ 2M SDE Heun Exponential", "DPM++ 3M SDE", "DPM++ 3M SDE Karras", "DPM++ 3M SDE Exponential", "DPM fast", "DPM adaptive", "LMS Karras", "DPM2 Karras", "DPM2 a Karras", "DPM++ 2S a Karras", "Restart", "DDIM", "PLMS", "UniPC" ], "type": "string", "title": "sampler", "description": "Sampling method", "default": "Euler a", "x-order": 18 }, "ad_model": { "enum": [ "face_yolov8n", "face_yolov8s", "hand_yolov8n", "person_yolov8n-seg", "person_yolov8s-seg", "mediapipe_face_full", "mediapipe_face_short", "mediapipe_face_mesh", "mediapipe_face_mesh_eyes_only", "deepfashion2_yolov8s-seg", "\u0411\u0435\u0437 \u043c\u043e\u0434\u0435\u043b\u0438" ], "type": "string", "title": "ad_model", "description": "[adetailer] ADetailer model", "default": "face_yolov8s", "x-order": 21 }, "ad_prompt": { "type": "string", "title": "Ad Prompt", "default": "", "x-order": 22, "description": "[adetailer] ADetailer prompt" }, "cfg_scale": { "type": "number", "title": "Cfg Scale", "default": 7, "x-order": 12, "description": "CFG scale" }, "mask_blur": { "type": "integer", "title": "Mask Blur", "default": 4, "x-order": 7, "description": "Mask blur" }, "ad_enabled": { "type": "boolean", "title": "Ad Enabled", "default": false, "x-order": 20, "description": "[adetailer] Enable" }, "ad_sampler": { "enum": [ "DPM++ 2M Karras", "DPM++ SDE Karras", "DPM++ 2M SDE Exponential", "DPM++ 2M SDE Karras", "Euler a", "Euler", "LMS", "Heun", "DPM2", "DPM2 a", "DPM++ 2S a", "DPM++ SDE", "DPM++ 2M SDE", "DPM++ 2M SDE Heun Karras", "DPM++ 2M SDE Heun Exponential", "DPM++ 3M SDE", "DPM++ 3M SDE Karras", "DPM++ 3M SDE Exponential", "DPM fast", "DPM adaptive", "LMS Karras", "DPM2 Karras", "DPM2 a Karras", "DPM++ 2S a Karras", "Restart", "DDIM", "PLMS", "UniPC" ], "type": "string", "title": "ad_sampler", "description": "[adetailer] ADetailer sampler", "default": "Euler a", "x-order": 25 }, "image_mask": { "type": "string", "title": "Image Mask", "format": "uri", "x-order": 6, "description": "Mask" }, "num_outputs": { "type": "integer", "title": "Num Outputs", "default": 1, "maximum": 4, "minimum": 1, "x-order": 17, "description": "Batch size [Doesn't work in postprocess mode]." }, "resize_mode": { "enum": [ "Just resize", "Resize and fill" ], "type": "string", "title": "resize_mode", "description": "Resize mode", "default": "Just resize", "x-order": 8 }, "upload_lora": { "type": "string", "title": "Upload Lora", "x-order": 2, "description": "Upload LoRA" }, "ad_mask_blur": { "type": "integer", "title": "Ad Mask Blur", "default": 4, "x-order": 28, "description": "[adetailer] Inpaint mask blur" }, "ad_confidence": { "type": "number", "title": "Ad Confidence", "default": 0.3, "x-order": 26, "description": "[adetailer] Detection model confidence threshold" }, "sampler_steps": { "type": "integer", "title": "Sampler Steps", "default": 20, "maximum": 50, "minimum": 1, "x-order": 19, "description": "Sampling steps [Doesn't work in postprocess mode]." }, "ad_use_sampler": { "type": "boolean", "title": "Ad Use Sampler", "default": true, "x-order": 24, "description": "[adetailer] Use separate sampler" }, "ad_dilate_erode": { "type": "integer", "title": "Ad Dilate Erode", "default": 4, "x-order": 27, "description": "[adetailer] Mask erosion (-) / dilation (+)" }, "generation_type": { "enum": [ "img2img", "postprocess" ], "type": "string", "title": "generation_type", "description": "Generation mode", "default": "img2img", "x-order": 0 }, "inpainting_fill": { "enum": [ "Fill", "Original", "Latent noise" ], "type": "string", "title": "inpainting_fill", "description": "Masked content", "default": "Original", "x-order": 9 }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "default": "(deformed, distorted, disfigured:1.3), (naked, nude:1.5), poorly drawn, bad anatomy, wrong anatomy, extra limb, missing limb, floating limbs, (mutated hands and fingers:1.4), disconnected limbs, mutation, mutated, ugly, disgusting, blurry, amputation", "x-order": 4, "description": "Negative prompt" }, "ad_inpaint_width": { "type": "integer", "title": "Ad Inpaint Width", "default": 512, "x-order": 34, "description": "[adetailer] Inpaint width" }, "inpaint_full_res": { "enum": [ "Whole picture", "Only masked" ], "type": "string", "title": "inpaint_full_res", "description": "Inpaint area", "default": "Whole picture", "x-order": 10 }, "ad_inpaint_height": { "type": "integer", "title": "Ad Inpaint Height", "default": 512, "x-order": 35, "description": "[adetailer] Inpaint height" }, "ad_mask_merge_mode": { "enum": [ "None", "Merge", "Merge and Invert" ], "type": "string", "title": "ad_mask_merge_mode", "description": "[adetailer] Mask merge mode", "default": "None", "x-order": 29 }, "ad_negative_prompt": { "type": "string", "title": "Ad Negative Prompt", "default": "", "x-order": 23, "description": "[adetailer] ADetailer negative prompt" }, "denoising_strength": { "type": "number", "title": "Denoising Strength", "default": 0.75, "x-order": 13, "description": "[HR] Denoising strength" }, "ad_denoising_strength": { "type": "number", "title": "Ad Denoising Strength", "default": 0.4, "x-order": 30, "description": "[adetailer] Inpaint denoising strength" }, "ad_inpaint_only_masked": { "type": "boolean", "title": "Ad Inpaint Only Masked", "default": true, "x-order": 31, "description": "[adetailer] Inpaint only masked" }, "clip_stop_at_last_layers": { "type": "integer", "title": "Clip Stop At Last Layers", "default": 2, "maximum": 12, "minimum": 1, "x-order": 1, "description": "Clip skip" }, "inpaint_full_res_padding": { "type": "integer", "title": "Inpaint Full Res Padding", "default": 32, "x-order": 11, "description": "Only masked padding, pixels" }, "ad_use_inpaint_width_height": { "type": "boolean", "title": "Ad Use Inpaint Width Height", "default": false, "x-order": 33, "description": "[adetailer] Use separate width/height" }, "ad_inpaint_only_masked_padding": { "type": "integer", "title": "Ad Inpaint Only Masked Padding", "default": 32, "x-order": 32, "description": "[adetailer] Inpaint only masked padding, pixels" } }}Output schema
The shape of the response you’ll get when you run this model with an API.
Schema
{ "type": "object", "title": "Output", "required": [ "images", "seeds", "prompt" ], "properties": { "seeds": { "type": "array", "items": { "type": "string" }, "title": "Seeds" }, "images": { "type": "array", "items": { "type": "string", "format": "uri" }, "title": "Images" }, "prompt": { "type": "string", "title": "Prompt" } }}