v2

latestOpenAPI 3.1.0raw.githubusercontent.com2024-07-2562352.8 KB

Adetailer

Detail the given image.

post/adetailer

Request body

cfg_scalenumber

Floating-point number represeting how closely to adhere to prompt description. Must be a positive number no greater than 50.0.

checkpointstring nullable

Name of a checkpoint to use for inpainting.

confidencenumber

Inpainted areas are determined using a detector. This setting adjusts the sensitivity of the detector (lower considers more image fragments for inpainting).

detector'face_yolov8n' | 'hand_yolov8n' | 'face_full_mediapipe' | 'face_short_mediapipe' | 'face_mesh_mediapipe' | 'eyes_mesh_mediapipe' | 'face_hair_mediapipe' required

ADetailer detector models available.

image_encoding'jpeg' | 'png'

The image encoding types available for image modification response.

init_imagestring nullable

base64-encoded image to modify. Resolution must be supported by inpainting_base_model: sdxl: 640x1536, 768x1344, 832x1216, 896x1152, 1024x1024, 1152x896, 1216x832, 1344x768, 1536x640, 1664x2432, 2048x2048, 2432x1664; sd15: 384x704, 448x576, 512x512, 512x704, 512x768, 512x832, 576x448, 576x768, 576x768, 576x1024, 640x512, 640x640, 640x768, 704x384, 704x1216, 768x512, 768x576, 768x1024, 832x512, 896x896, 1024x576, 1024x768, 1024x1024, 1024x1536, 1216x704, 1536x1024.

init_image_urlstring nullable

If given, download init_image from this URL.

inpainting_base_model'sdxl' | 'sd15'

Base model which ADetailer should use for inpainting.

lorasobject nullable

A dict mapping the name of a LoRA to apply to its weight.

mask_blurinteger

A mask is created for each inpainted area in the image. After dilation (see mask_dilation parameter), the mask is blurred. This technique is typically used to smoothly blend the inpainted area with the original image. This option specifies the radius, in pixels, of the gaussian blur kernel. The higher the value, the wider the blur. Defaults to 4. Must be greater than or equal to 0 and recommended to be less than 64.

mask_dilationinteger

A mask is created for each inpainted area in the image. Mask Dilation allows you to expand the size of the mask while maintaining its shape. This technique is typically used to reduce artifacts near borders in the mask. This parameter is the size, in pixels, of the dilation kernel to apply. Defaults to 4. Must be greater than or equal to 0 and recommended to be less than 64.

mask_paddinginteger

Each inpainted area is passed to the image-to-image generator with some surrounding context. The contextual area is created by padding the area occupied by the blurred, dilated mask. This technique improves inpainting quality, and the contextual area is not modified. This parameter specifies the amount of padding, in pixels, to apply around the processed mask. When the computed padding goes off the edge of the image, the padded area is slid towards the center of the image. Must be greater than or equal to 0 and recommended to be less than 10% the size of an inpainting mask.

max_num_detectionsinteger nullable

Inpaint at most this many objects, starting with the most confident matches.

negative_promptstring nullable

Inpainting negative prompt.

promptstring nullable

Inpainting input prompt.

sampler'PNDM' | 'LMS' | 'KLMS' | 'DDIM' | 'DDPM' | 'HEUN' | 'K_HEUN' | 'K_EULER' | 'K_EULER_ANCESTRAL' | 'DPM_SOLVER_MULTISTEP' | 'DPM_PLUS_PLUS_2M_KARRAS' | 'DPM_SINGLE' | 'DPM_2' | 'DPM_2_ANCESTRAL' | 'DPM_PLUS_PLUS_SDE_KARRAS' | 'UNI_PC' | 'LCM'

The schedulers available for image generation.

stepsinteger

Number of SDXL inference steps.

strengthnumber

Floating-point number indicating how creative the Image to Image generation mode should be. Must be greater than 0 and less than or equal to 1.0.

style_presetstring

Used to guide the SDXL inpainter towards a particular style.

transfer_imagesobject nullable

If given, a dict whose keys are strings containing the index of the face to modify (faces 0-indexed top-to-bottom, left-to-right; faces with 75% vertical overlap with the leftmost image in a row are counted in that row). Values are a list of base64 example faces which are together used to replace the indexed face.

union_masksboolean

When true, create a single mask by unioning the mask for each detected object together, then send a single inpainting request to the backing model.

use_refinerboolean

Whether to apply the SDXL refiner.

Response

Successful Response

image_b64string nullable required

The modified image or None if it was removed for safety.

init_image_removed_for_safetyboolean required

True when the init_image failed the safety checker, so no processing was done.

num_objects_detectedinteger required

The number of objects that were successfully detected.

num_objects_inpaintedinteger required

The number of objects that were successfully inpainted.

num_removed_for_safetyinteger required

Number of inpainting requests that violated the OctoAI Terms of Service.

All 6 operations