Start Upscaling Task

curl --request POST \
  --url https://api.upscayl.org/start-task \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'file=<string>' \
  --form scale=4 \
  --form enhanceFace=true \
  --form 'files={
  "fileName": "1k2jj2b3c-cnb1234ij.jpg",
  "fileType": "image/jpeg",
  "fileSize": 123456,
  "originalFileName": "image.jpg",
  "path": "users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg",
  "createdAt": 1640995200,
  "expiresAt": 1640995200,
  "dimensions": {
    "width": 123,
    "height": 123
  }
}' \
  --form 'urls=<string>' \
  --form 0.file='@example-file' \
  --form 1.file='@example-file' \
  --form 2.file='@example-file'

import requests

url = "https://api.upscayl.org/start-task"

files = {
    "0.file": ("example-file", open("example-file", "rb")),
    "1.file": ("example-file", open("example-file", "rb")),
    "2.file": ("example-file", open("example-file", "rb"))
}
payload = {
    "file": "<string>",
    "scale": "4",
    "enhanceFace": "true",
    "files": "{
  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",
  \"fileType\": \"image/jpeg\",
  \"fileSize\": 123456,
  \"originalFileName\": \"image.jpg\",
  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",
  \"createdAt\": 1640995200,
  \"expiresAt\": 1640995200,
  \"dimensions\": {
    \"width\": 123,
    \"height\": 123
  }
}",
    "urls": "<string>"
}
headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('scale', '4');
form.append('enhanceFace', 'true');
form.append('files', '{
  "fileName": "1k2jj2b3c-cnb1234ij.jpg",
  "fileType": "image/jpeg",
  "fileSize": 123456,
  "originalFileName": "image.jpg",
  "path": "users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg",
  "createdAt": 1640995200,
  "expiresAt": 1640995200,
  "dimensions": {
    "width": 123,
    "height": 123
  }
}');
form.append('urls', '<string>');
form.append('0.file', '{
  "fileName": "example-file"
}');
form.append('1.file', '{
  "fileName": "example-file"
}');
form.append('2.file', '{
  "fileName": "example-file"
}');

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

options.body = form;

fetch('https://api.upscayl.org/start-task', 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://api.upscayl.org/start-task",
  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=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upscayl.org/start-task"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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("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.post("https://api.upscayl.org/start-task")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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://api.upscayl.org/start-task")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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

{
  "status": "success",
  "data": {
    "message": "Task request sent successfully",
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "creditsToDeduct": 10
  }
}

"Bad Request: Missing User"

"Insufficient credits"

"User not found"

"Error processing request"

POST

start-task

Start Upscaling Task

curl --request POST \
  --url https://api.upscayl.org/start-task \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'file=<string>' \
  --form scale=4 \
  --form enhanceFace=true \
  --form 'files={
  "fileName": "1k2jj2b3c-cnb1234ij.jpg",
  "fileType": "image/jpeg",
  "fileSize": 123456,
  "originalFileName": "image.jpg",
  "path": "users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg",
  "createdAt": 1640995200,
  "expiresAt": 1640995200,
  "dimensions": {
    "width": 123,
    "height": 123
  }
}' \
  --form 'urls=<string>' \
  --form 0.file='@example-file' \
  --form 1.file='@example-file' \
  --form 2.file='@example-file'

import requests

url = "https://api.upscayl.org/start-task"

files = {
    "0.file": ("example-file", open("example-file", "rb")),
    "1.file": ("example-file", open("example-file", "rb")),
    "2.file": ("example-file", open("example-file", "rb"))
}
payload = {
    "file": "<string>",
    "scale": "4",
    "enhanceFace": "true",
    "files": "{
  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",
  \"fileType\": \"image/jpeg\",
  \"fileSize\": 123456,
  \"originalFileName\": \"image.jpg\",
  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",
  \"createdAt\": 1640995200,
  \"expiresAt\": 1640995200,
  \"dimensions\": {
    \"width\": 123,
    \"height\": 123
  }
}",
    "urls": "<string>"
}
headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('scale', '4');
form.append('enhanceFace', 'true');
form.append('files', '{
  "fileName": "1k2jj2b3c-cnb1234ij.jpg",
  "fileType": "image/jpeg",
  "fileSize": 123456,
  "originalFileName": "image.jpg",
  "path": "users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg",
  "createdAt": 1640995200,
  "expiresAt": 1640995200,
  "dimensions": {
    "width": 123,
    "height": 123
  }
}');
form.append('urls', '<string>');
form.append('0.file', '{
  "fileName": "example-file"
}');
form.append('1.file', '{
  "fileName": "example-file"
}');
form.append('2.file', '{
  "fileName": "example-file"
}');

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

options.body = form;

fetch('https://api.upscayl.org/start-task', 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://api.upscayl.org/start-task",
  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=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upscayl.org/start-task"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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("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.post("https://api.upscayl.org/start-task")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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://api.upscayl.org/start-task")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scale\"\r\n\r\n4\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhanceFace\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n{\r\n  \"fileName\": \"1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"fileType\": \"image/jpeg\",\r\n  \"fileSize\": 123456,\r\n  \"originalFileName\": \"image.jpg\",\r\n  \"path\": \"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg\",\r\n  \"createdAt\": 1640995200,\r\n  \"expiresAt\": 1640995200,\r\n  \"dimensions\": {\r\n    \"width\": 123,\r\n    \"height\": 123\r\n  }\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.file\"; 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.file\"; 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=\"2.file\"; 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

{
  "status": "success",
  "data": {
    "message": "Task request sent successfully",
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "creditsToDeduct": 10
  }
}

"Bad Request: Missing User"

"Insufficient credits"

"User not found"

"Error processing request"

Authorizations

X-API-Key

string

header

required

API key required to access the API. You can obtain an API key at https://upscayl.org/account/api-keys

Body

multipart/form-data

Option 1
Option 2
Option 3

file

required

The image file to be processed. Supported formats: JPG, PNG, WEBP.

model

enum<string>

required

The available AI models for upscaling

Available options:

upscayl-standard-4x,

upscayl-lite-4x,

clear-boost-4x,

crystal-plus-4x,

digital-art-4x,

digital-art-plus-4x,

natural-max-4x,

natural-plus-4x,

nature-boost-4x,

pure-boost-4x,

quick-clear-4x,

texture-boost-4x

scale

enum<integer>

required

The scaling factor for the task

Available options:

1,

2,

3,

4,

5,

6,

7,

8

Example:

4

saveImageAs

enum<string>

required

The available image formats for saving

Available options:

jpg,

png,

webp

enhanceFace

boolean

required

Whether to enhance faces in the image.

files

object[]

The files to be processed. This is to be only used with 'Get Upload URL' endpoint.

Show child attributes

urls

string<uri>[]

Array of URLs pointing to images to be processed.

Response

Task request sent successfully

status

string

Example:

"success"

data

object

Show child attributes

Logs Get Task Status