---
title: "Upscaler Creative - Upscale image"
method: POST
path: "/v1/ai/image-upscaler"
tags: ["image-upscaler"]
---

# Upscaler Creative - Upscale image

`POST /v1/ai/image-upscaler`

## Request

- Base URL: `https://api.magnific.com`
- URL: `https://api.magnific.com/v1/ai/image-upscaler`
- Auth: API key in header `x-magnific-api-key`

This asynchronous endpoint enables image upscaling using advanced AI algorithms. Upon submission, it returns a unique `task_id` which can be used to track the progress of the upscaling process. For real-time production use, include the optional `webhook_url` parameter to receive an automated notification once the task has been completed. This allows for seamless integration and efficient task management without the need for continuous polling.

## Request body

- ImageUpscaleRequestContent
  - `image` string, byte, required: Base64 image to upscale The resulted image can't exceed maximum allowed size of 25.3 million pixels.
  - `webhook_url` string, uri: Optional callback URL that will receive asynchronous notifications whenever the task changes status. The payload sent to this URL is the same as the corresponding GET endpoint response, but without the data field.
  - `scale_factor` '2x' | '4x' | '8x' | '16x': Configure scale factor of the image. For higher scales, the image will take longer to process
  - `optimized_for` 'standard' | 'soft_portraits' | 'hard_portraits' | 'art_n_illustration' | 'videogame_assets' | 'nature_n_landscapes' | 'films_n_photography' | '3d_renders' | 'science_fiction_n_horror': Styles to optimize the upscale process
  - `prompt` string: Prompt to guide the upscale process. Reusing the same prompt for AI-generated images will improve the results
  - `creativity` integer: Increase or decrease AI's creativity. Valid values range `[-10, 10]`, default `0`.
  - `hdr` integer: Increase or decrease the level of definition and detail. Valid values range `[-10, 10]`, default `0`.
  - `resemblance` integer: Adjust the level of resemblance to the original image. Valid values range `[-10, 10]`, default `0`.
  - `fractality` integer: Control the strength of the prompt and intricacy per square pixel. Valid values range `[-10, 10]`, default `0`.
  - `engine` 'automatic' | 'magnific_illusio' | 'magnific_sharpy' | 'magnific_sparkle': Magnific model engines
  - `filter_nsfw` boolean: Controls **NSFW** (Not Safe For Work) content filtering on the upscaled image. When set to `true`, the output image will be scanned and filtered to prevent NSFW content from being returned. Default is `false`.

## Response `200`

OK - The request has succeeded and the upscaling process has started. The result will be notified by a Webhook call

- GetStyleTransferTaskStatus200Response
  - `data` TaskDetail, required
    - `task_id` string, uuid, required: Task identifier
    - `status` 'CREATED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED', required: Task status
    - `generated` string[], required

## Other responses

- `400`: Bad Request - The server could not understand the request due to invalid syntax.
- `401`: Unauthorized - The client must authenticate itself to get the requested response.
- `500`: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- `503`: Service Unavailable

---

[API](https://skmtc.dev/magnific/apis/magnific-api.md) · [All operations](https://skmtc.dev/magnific/apis/magnific-api/llms.txt) · [OpenAPI document](https://skmtc.dev/magnific/apis/magnific-api/revisions/60711fb082c7?raw)