Get Task Status
This endpoint retrieves the status of a task, including whether it has been processed, credits deducted, and file download links. It also handles credit deduction if the task is processed and credits have not been deducted yet.
curl --request POST \
--url https://api.upscayl.org/get-task-status \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"data": {
"taskId": "<string>"
}
}'
{
"status": "success",
"data": {
"status": "ENHANCING",
"progress": "100",
"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
}
}
],
"deductedCredits": 10,
"creditsDeducted": true,
"model": "upscayl-standard-4x",
"scale": 4,
"saveImageAs": "png",
"compression": 80,
"batchMode": false
}
}
Authorizations
API key required to access the API. You can obtain an API key at https://upscayl.org/account/api-keys
Response
"success"
The status of the task
ENHANCING
, PROCESSING
, PROCESSED
, PROCESSING_FAILED
"100"
The name of the file.
"1k2jj2b3c-cnb1234ij.jpg"
The MIME type of the file.
"image/jpeg"
The size of the file in bytes.
123456
The original name of the file.
"image.jpg"
The path where the file is stored.
"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg"
Timestamp of file creation.
1640995200
Timestamp of file expiration.
1640995200
10
true
The available AI models for upscaling
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
The scaling factor for the task
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
4
"png"
80
false
curl --request POST \
--url https://api.upscayl.org/get-task-status \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"data": {
"taskId": "<string>"
}
}'
{
"status": "success",
"data": {
"status": "ENHANCING",
"progress": "100",
"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
}
}
],
"deductedCredits": 10,
"creditsDeducted": true,
"model": "upscayl-standard-4x",
"scale": 4,
"saveImageAs": "png",
"compression": 80,
"batchMode": false
}
}