cURL
curl --request POST \ --url https://api.upscayl.org/start-task \ --header 'Content-Type: multipart/form-data' \ --header 'X-API-Key: <api-key>' \ --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 model=upscayl-standard-4x \ --form scale=4 \ --form saveImageAs=jpg \ --form enhanceFace=true \ --form file=@example-file
{ "status": "success", "data": { "message": "Task request sent successfully", "taskId": "123e4567-e89b-12d3-a456-426614174000", "creditsToDeduct": 10 } }
This endpoint processes an upscaling task request, including file uploads.
API key required to access the API. You can obtain an API key at https://upscayl.org/account/api-keys
Task request sent successfully
The response is of type object.
object