Image Upscale Service v1.0.4
A REST API for AI-based image upscaling using Real-ESRGAN.
This service allows you to upload images and upscale them by 2x, 3x,
or 4x using various optimized models.
Note: I have good results with 2x and 3x, but not with 4x on certain images.
This service allows you to upload images and upscale them by 2x, 3x,
or 4x using various optimized models.
Note: I have good results with 2x and 3x, but not with 4x on certain images.
POST
/cancel/{job_id}
Cancel job
Cancel a running or queued job.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| job_id* | path | string |
Responses
200
Job cancelled successfully
400
Bad request (e.g. job already completed)
404
Job not found
GET
/download/{job_id}
Download upscaled image
Retrieve the result of a completed upscaling job.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| job_id* | path | string | The ID of the job returned by the /upscale endpoint. |
Responses
200
The upscaled image file.
404
Job or file not found
GET
/health
Health check
Returns the health status and version of the service.
Responses
200
Service is healthy
GET
/models
List available models
Get a list of installed AI models and the service version.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| scale | query | integer | Filter models that support this specific scaling factor. |
Responses
200
List of models
GET
/status/{job_id}
Get job status
Check the progress or status of a specific job. If completed, returns result details.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| job_id* | path | string |
Responses
200
Current job status
404
Job not found
POST
/upscale
Upscale an image
Upload an image file to be upscaled. This is an asynchronous operation.
Request Body
multipart/form-data
| Field | Type | Description |
|---|---|---|
| image* | string | The image file to upscale (PNG, JPG, WEBP). |
| scale | integer | The upscaling factor. |
| model_name | string | The name of the model to use. See /models for available options. |
| tile_size | integer | Tile size for processing large images (0 = auto). Use smaller values (e.g., 400) to reduce VRAM usage. |
| format | string | Output format (optional, defaults to input format or png). |
Responses
202
Job accepted
400
Invalid input (e.g., unsupported scale or missing image)
500
Internal server error