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>'

import requests

url = "https://cloud.comfy.org/api/files/mask-layers"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://cloud.comfy.org/api/files/mask-layers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.comfy.org/api/files/mask-layers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.comfy.org/api/files/mask-layers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://cloud.comfy.org/api/files/mask-layers")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.comfy.org/api/files/mask-layers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

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

{
  "code": "<string>",
  "message": "<string>"
}

Authorizations

X-API-Key · string · header · required

API key authentication. Generate an API key from your account settings at https://platform.comfy.org/profile/api-keys. 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