POST
/
get-task-status
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

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

application/json
data
object

Response

200
application/json
Task status retrieved successfully
status
string
data
object