Get related mask layer files

Given a mask file (any of the 4 layers), returns all related mask layer files. This is used by the mask editor to load the paint, mask, and painted layers when reopening a previously edited mask.

GET /api/files/mask-layers

Get related mask layer files

cURL

curl --request GET \
  --url https://cloud.comfy.org/api/files/mask-layers \
  --header 'X-API-Key: <api-key>'

200

{
  "mask": "<string>",
  "paint": "<string>",
  "painted": "<string>",
  "painted_masked": "<string>"
}

Authorizations

X-API-Key · string · header · required

API key authentication. Generate an API key from your account settings at https://comfy.org/account. Pass the key in the X-API-Key header.

Query Parameters

filename · string · required

Hash filename of any mask layer file

Example:

"abc123def456.png"

Response

200

application/json

Success - Related mask layers returned

mask · string | null

Filename of the mask layer

paint · string | null

Filename of the paint strokes layer

painted · string | null

Filename of the painted image layer

painted_masked · string | null

Filename of the final composite layer