Skip to main content
POST
/
api
/
portrait
/
effects
/
ai-halloween-mask
AI Halloween Mask
curl --request POST \
  --url https://www.ailabapi.com/api/portrait/effects/ai-halloween-mask \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form 'image=<string>' \
  --form 'image_template=<string>' \
  --form aspect_ratio=auto \
  --form 0.image='@example-file' \
  --form 0.image_template='@example-file' \
  --form 1.image='@example-file' \
  --form 1.image_template='@example-file'
import requests

url = "https://www.ailabapi.com/api/portrait/effects/ai-halloween-mask"

files = {
    "0.image": ("example-file", open("example-file", "rb")),
    "0.image_template": ("example-file", open("example-file", "rb")),
    "1.image": ("example-file", open("example-file", "rb")),
    "1.image_template": ("example-file", open("example-file", "rb"))
}
payload = {
    "image": "<string>",
    "image_template": "<string>",
    "aspect_ratio": "auto"
}
headers = {"ailabapi-api-key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('image', '<string>');
form.append('image_template', '<string>');
form.append('aspect_ratio', 'auto');
form.append('0.image', '{
  "fileName": "example-file"
}');
form.append('0.image_template', '{
  "fileName": "example-file"
}');
form.append('1.image', '{
  "fileName": "example-file"
}');
form.append('1.image_template', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {'ailabapi-api-key': '<api-key>'}};

options.body = form;

fetch('https://www.ailabapi.com/api/portrait/effects/ai-halloween-mask', 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://www.ailabapi.com/api/portrait/effects/ai-halloween-mask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_template\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "ailabapi-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.ailabapi.com/api/portrait/effects/ai-halloween-mask"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_template\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ailabapi-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.post("https://www.ailabapi.com/api/portrait/effects/ai-halloween-mask")
  .header("ailabapi-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_template\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://www.ailabapi.com/api/portrait/effects/ai-halloween-mask")

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

request = Net::HTTP::Post.new(url)
request["ailabapi-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_template\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image_template\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "request_id": "",
  "log_id": "",
  "error_detail": {
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_id": ""
}

​
Query Task

This is an asynchronous task API. The submission request returns only task_id.Use task_id to call Querying Async Task Results and retrieve the final result. Async task results remain available for 24 hours. Query every 5 seconds.
FieldTypeDescription
dataobjectFinal result data.
+result_urlsarrayResult image URLs.
++result_urls[]stringResult image URL.
{
  "data": {
    "result_urls": [""]
  }
}
result_urls are temporary and remain valid for 24 hours. Download the files to your own storage before the URLs expire if you need long-term storage.

​
Submit Task

​
mask_style

The following enum values are supported for mask_style.

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data

Provide mask_style or image_template. If both are provided, mask_style takes precedence.

​
image
file
required

Source image.

  • Image format: JPEG JPG PNG WEBP
  • Image size: No more than 10 MB.
  • Image resolution: Less than 4096x4096px.
​
mask_style
enum<string>
required

Built-in mask preset. Provide either this field or image_template. If both are provided, mask_style takes precedence. See Supported mask styles.

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85
​
image_template
file

Reference image for eyeshadow transfer. Provide this field or mask_style. If both are provided, image_template is ignored.

  • Image format: JPEG JPG PNG WEBP
  • Image size: No more than 10 MB.
  • Image resolution: Less than 4096x4096px.
​
aspect_ratio
enum<string>
default:auto

Output Image Aspect Ratio.

Available options:
auto,
1:1,
3:4,
4:3,
9:16,
16:9

Response

200 - application/json

Success

​
request_id
string
required

Request ID for debugging.

​
log_id
string
required

Log ID for debugging.

​
error_detail
object
required
​
task_id
string
required

Task ID for querying Querying Async Task Results.