POST
/
v1
/
ai
/
image-upscaler
curl --request POST \
  --url https://api.freepik.com/v1/ai/image-upscaler \
  --header 'Content-Type: <content-type>' \
  --header 'x-freepik-api-key: <api-key>' \
  --data '{
  "image": "iVBORw0KGgoAAAANSUhEUgAAASwAAAEsAQAAAABRBrPYAAABrElEQVR4nO3BMQEAAADCoPVPbQ0Po...",
  "webhook_url": "https://httpbin.org/post",
  "scale_factor": "2x",
  "optimized_for": "standard",
  "prompt": "Crazy dog in the space",
  "creativity": 2,
  "hdr": 1,
  "resemblance": 0,
  "fractality": -1,
  "engine": "magnific_sparkle"
}'
{
  "data": {
    "generated": [],
    "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "status": "IN_PROGRESS"
  }
}

​
Important

Upscaler endpoints are only available for premium API users. You can upgrade your account here.

For a comprehensive guide on this service, including use cases and detailed functionality, check out our Image Upscaler Guide.

​
Request

Authorizations

x-freepik-api-key
string
headerrequired

Your Freepik API key. Required for authentication. Learn how to obtain an API key

Headers

Content-Type
string
required

The Content-Type header must be set to application/json to indicate that the payload is formatted as JSON. If a different Content-Type is provided, the payload will be ignored, and the request will proceed without processing the body.

Body

application/json
image
string
required

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

webhook_url
string

Webhook URL to receive the upscaled image once it's ready

scale_factor
enum<string>
default: 2x

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

Available options:
2x,
4x,
8x,
16x
optimized_for
enum<string>
default: standard

Styles to optimize the upscale process

Available options:
standard,
soft_portraits,
hard_portraits,
art_n_illustration,
videogame_assets,
nature_n_landscapes,
films_n_photography,
3d_renders,
science_fiction_n_horror
prompt
string

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

creativity
integer
default: 0

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

hdr
integer
default: 0

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

resemblance
integer
default: 0

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

fractality
integer
default: 0

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

engine
enum<string>
default: automatic

Magnific model engines

Available options:
automatic,
magnific_illusio,
magnific_sharpy,
magnific_sparkle

Response

200 - application/json
data
object
required

Was this page helpful?

Create image from text - Classic fastGet the status of the upscaling task