Image Upscaler API

Request

Image requirements

• Image format: JPEG JPG PNG BMP
• Image size: No more than 3 MB.
• Image resolution: Larger than 32x32px, smaller than 1920x1080px.

Body

Field	Required	Type	Scope	Default	Description
image	YES	file
upscale_factor	NO	integer	2 3 4	2	Magnification.
mode	NO	string	base enhancement	base	Image output mode. base: Normal mode, i.e. stable super-resolution effect. enhancement: Enhancement mode, which has a more prominent enhancement effect than the normal mode, further improving the clarity and sharpness of the output image.
output_format	NO	string	png jpg bmp	png	Output image format.
output_quality	NO	integer	[30, 100]	95	Quality factor of the output image, where a higher value corresponds to higher quality. Only applicable when output_format=jpg.

Response

Response Field Handling Flow

1. Handle Public Response Fields

   Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.

2. Handle Business Response Fields

   If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

Public Response Fields

Viewing Public Response Fields and Error Codes

Business Response Fields

Field	Type	Description
data	object	The content of the result data returned.
+url	string	URL address of the image after resolution enlargement, image format is PNG.

tip

The URL address is a temporary address, valid for 24 hours, and will not be accessible after it expires. If you need to save the file for a long time or permanently, please visit the URL address within 24 hours and download the file to your own storage space.

Response Example

{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "url": ""
  }
}