Sign in

v1

latestOpenAPI 3.0.22026-07-2610288167.4 KB
Freepik
Proxy

Upscale an image with Magnific

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. For real-time production use, include the optional webhook_url parameter to receive an automated notification once the task has been completed.

post/proxy/freepik/v1/ai/image-upscaler

Request body

creativityinteger

Increase or decrease AI's creativity. Valid values range [-10, 10].

engine'automatic' | 'magnific_illusio' | 'magnific_sharpy' | 'magnific_sparkle'

Magnific model engines.

fractalityinteger

Control the strength of the prompt and intricacy per square pixel. Valid values range [-10, 10].

hdrinteger

Increase or decrease the level of definition and detail. Valid values range [-10, 10].

imagestring required

Base64 image or URL to upscale. The resulted image can't exceed maximum allowed size of 25.3 million pixels.

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.

promptstring

Prompt to guide the upscale process. Reusing the same prompt for AI-generated images will improve the results.

resemblanceinteger

Adjust the level of resemblance to the original image. Valid values range [-10, 10].

scale_factor'2x' | '4x' | '8x' | '16x'

Configure scale factor of the image. For higher scales, the image will take longer to process.

webhook_urlstring uri

Optional callback URL that will receive asynchronous notifications whenever the task changes status.

Example request

{
  "webhook_url": "https://www.example.com/webhook"
}

Response

OK - The upscaling process has started

Example response

{
  "data": {
    "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}