POST
/
v1
/
ai
/
image-upscaler
curl --request POST \
  --url https://api.freepik.com/v1/ai/image-upscaler \
  --header 'Content-Type: application/json' \
  --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

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
header
required

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

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.

Required range: -10 <= x <= 10
​
hdr
integer
default:0

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

Required range: -10 <= x <= 10
​
resemblance
integer
default:0

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

Required range: -10 <= x <= 10
​
fractality
integer
default:0

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

Required range: -10 <= x <= 10
​
engine
enum<string>
default:automatic

Magnific model engines

Available options:
automatic,
magnific_illusio,
magnific_sharpy,
magnific_sparkle

Response

200
application/json
OK - The request has succeeded and the upscaling process has started. The result will be notified by a Webhook call
​
data
object
required
Example:
{
  "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "status": "IN_PROGRESS",
  "generated": [
    "https://openapi-generator.tech",
    "https://openapi-generator.tech"
  ]
}

Was this page helpful?

Suggest edits