file

Upload a mask image

Upload a mask image to be applied to an existing image.

Image limits apply to both the uploaded mask and the referenced original image:

Uploads that exceed any of these limits are rejected with HTTP 400.

post/api/upload/mask

Request

Base URL
https://api.comfy.org
Auth
none required
TypeScript
https://skmtc.dev/ac/apis/comfy-api/docs/api/upload/mask/post.ts
A function with typed inputs. Its response is checked against the schema.

imagestring binary required

The mask image file to upload

original_refstring required

JSON string containing reference to the original image

Mask uploaded successfully

namestring

Filename of the uploaded mask

subfolderstring

Subfolder path where mask was saved

typestring

Type of upload (e.g., "output")

No recorded changes to this operation across all 1 revision of this API.