> ## Documentation Index
> Fetch the complete documentation index at: https://ailabtools.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Image Upscaler API

> Image Upscaler API enlarges images 2x to 4x while enhancing detail, reducing noise, and preserving visual quality.

## Request

* **URL**: `https://www.ailabapi.com/api/image/enhance/image-lossless-enlargement`
* **Method**: `POST`
* **Content-Type**: `multipart/form-data`

### Image requirements

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

### Headers

| Field              | Required | Type     | Description                                           |
| :----------------- | :------- | :------- | :---------------------------------------------------- |
| `ailabapi-api-key` | YES      | `string` | Application API KEY. [Get API KEY](/docs/get-api-key) |

### 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`  | ``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. Note: If the input image is in RGBA format, the output will be forced to png to preserve both RGBA format and alpha channel accuracy.If the output image resolution exceeds 3840x2160, the output format will be automatically set to jpg. |
| `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

<Warning>
  **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`.
</Warning>

### Public Response Fields

<a href="/docs/response-description" target="_blank">Viewing Public Response Fields and Error Codes</a>

### 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.
</Tip>

### Response Example

```json theme={null}
{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "url": ""
  }
}
```


## OpenAPI

````yaml POST /api/image/enhance/image-lossless-enlargement
openapi: 3.0.0
info:
  title: AILabAPI
  description: >-
    [<b>AILabTools</b>](https://www.ailabtools.com) is an advanced tool that
    offers a vast array of simple and flexible API endpoints to suit your
    specific needs. With just one [<b>API
    KEY</b>](https://www.ailabtools.com/doc/get-api-key), you can easily call
    any of the endpoints and integrate them quickly into your application or
    workflow, allowing for smooth and efficient operations.


    [<b>AILabTools</b>](https://www.ailabtools.com) is continuously evolving,
    and you can anticipate even more API endpoints being added in the future,
    further enhancing its capabilities and usefulness for your artificial
    intelligence and machine learning requirements.
  version: 1.0.0
servers:
  - url: https://www.ailabapi.com
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: AI IMAGE
  - name: AI IMAGE > Image Enhancement
  - name: AI IMAGE > Image Effects
  - name: AI IMAGE > Image Editing
  - name: AI IMAGE > Image Scoring
  - name: AI BACKGROUND REMOVAL
  - name: AI BACKGROUND REMOVAL > Portrait
  - name: AI BACKGROUND REMOVAL > General
  - name: AI PORTRAIT
  - name: AI PORTRAIT > Portrait Effects
  - name: AI PORTRAIT > Portrait Enhance
  - name: AI PORTRAIT > Portrait Editing
  - name: AI PORTRAIT > Portrait Analysis
  - name: AI COMMON
paths:
  /api/image/enhance/image-lossless-enlargement:
    post:
      tags:
        - AI IMAGE > Image Enhancement
      summary: Image Upscaler
      description: >-
        Image Upscaler API enlarges images 2x to 4x while enhancing detail,
        reducing noise, and preserving visual quality.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
                upscale_factor:
                  type: string
                  description: Magnification.
                mode:
                  type: string
                  description: >-
                    Image output mode. <li>`base`: Normal mode, i.e. stable
                    super-resolution effect.</li> <li>`enhancement`: Enhancement
                    mode, which has a more prominent enhancement effect than the
                    normal mode, further improving the clarity and sharpness of
                    the output image.</li>
                output_format:
                  type: string
                  description: Output image format.
                output_quality:
                  type: string
                  description: >-
                    Quality factor of the output image, where a higher value
                    corresponds to higher quality. Only applicable when
                    `output_format=jpg`.
      responses:
        '200':
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                request_id: ''
                log_id: ''
                error_code: 0
                error_code_str: ''
                error_msg: ''
                error_detail:
                  status_code: 200
                  code: ''
                  code_message: ''
                  message: ''
                data:
                  url: ''
          description: Success
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: ailabapi-api-key
      description: API Key for authentication

````