Skip to main content
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 model=upscayl-standard-4x \
  --form scale=4 \
  --form saveImageAs=jpg \
  --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'
{
  "status": "success",
  "data": {
    "message": "Task request sent successfully",
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "creditsToDeduct": 10
  }
}

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

​
urls
string<uri>[]

Array of URLs pointing to images to be processed.

Response

Task request sent successfully

​
status
string
Example:

"success"

​
data
object