API Reference
Get Task Status
API Reference
Get Task Status
POST
/
get-task-status
{
"status": "success",
"data": {
"batchMode": true,
"enhanceFace": true,
"error": "<string>",
"files": [
{
"fileName": "<string>",
"fileType": "<string>",
"path": "<string>",
"createdAt": 123,
"expiresAt": 123,
"originalFileName": "<string>",
"fileSize": 123,
"downloadLink": "<string>",
"thumbnailLink": "<string>",
"finalFileSize": 123,
"processedFileName": "<string>",
"dimensions": {
"width": 123,
"height": 123
}
}
],
"model": "<string>",
"progress": "<string>",
"scale": "<string>",
"status": "<string>",
"saveImageAs": "png",
"compression": 123,
"creditsDeducted": true,
"deductedCredits": 123
}
}
Response
200 - application/json
Indicates if batch mode is enabled
The compression level
Indicates if credits were deducted
The number of credits deducted
Indicates if face enhancement is enabled
Error message if any
The model used for the task
The progress of the task
The format to save the image as
Available options:
png
, jpg
, webp
The scale of the task
The status of the task
{
"status": "success",
"data": {
"batchMode": true,
"enhanceFace": true,
"error": "<string>",
"files": [
{
"fileName": "<string>",
"fileType": "<string>",
"path": "<string>",
"createdAt": 123,
"expiresAt": 123,
"originalFileName": "<string>",
"fileSize": 123,
"downloadLink": "<string>",
"thumbnailLink": "<string>",
"finalFileSize": 123,
"processedFileName": "<string>",
"dimensions": {
"width": 123,
"height": 123
}
}
],
"model": "<string>",
"progress": "<string>",
"scale": "<string>",
"status": "<string>",
"saveImageAs": "png",
"compression": 123,
"creditsDeducted": true,
"deductedCredits": 123
}
}