For the complete documentation index, see llms.txt. This page is also available as Markdown.

AI Item Removal (Mask)

Removes specific items from a photo using a binary mask image you provide. White areas in the mask are removed; black areas are kept. Use this when you need precise control over which objects are removed.


Input Slots

Slot key
Description

tool-item-removal-mask-input-image

The original room photo

tool-item-removal-mask-input-mask

A binary mask image — blue (#7878CD) pixels = remove, black pixels = keep

Widgets

No widgets required.

Optional Field

Field
Description

process_group_id

Link this process to a preceding auto-detect process (from AI Item Removal)

Example Request

curl --location 'https://api.aihomedesign.com/v3/process' \
  --header 'x-api-key: <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "order_id": "694002a7bae1a7c81627e3cf",
    "tool": "tool-item-removal-mask",
    "process_group_id": "694002f74da0895282fbdb85",
    "asset_map": {
      "tool-item-removal-mask-input-image": "694002f74da0895282fbdb87",
      "tool-item-removal-mask-input-mask": "694003b24da0895282fbdb89"
    }
  }'

Tip: Upload the mask image to the same order using POST /v3/order/:id/append before creating this process. see complete request format here.

Last updated