Skip to main content
POST
/
v1
/
ai-image-upscaler
Python
from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.ai_image_upscaler.generate(
    assets={"image_file_path": "/path/to/1234.png"},
    scale_factor=2.0,
    style={"enhancement": "Balanced"},
    name="Image Upscaler image",
    wait_for_completion=True,
    download_outputs=True,
    download_directory="."
)
{
  "id": "cuid-example",
  "credits_charged": 50
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

​
scale_factor
number
required

How much to scale the image. Must be either 2 or 4.

Note: 4x upscale is only available on Creator, Pro, or Business tier.

Example:

2

​
style
object
required

Style settings for the upscale. Use mode to select between "pro" (faster, no enhancement required) and "creative" (defaults to "Balanced" enhancement). Defaults to "creative".

​
assets
object
required

Provide the assets for upscaling

​
name
string
default:Image Upscaler - dateTime

Give your image a custom name for easy identification.

Example:

"My Image Upscaler image"

Response

Success

Success

​
id
string
required

Unique ID of the image. Use it with the Get image Project API to fetch status and downloads.

Example:

"cuid-example"

​
credits_charged
integer
required

The amount of credits deducted from your account to generate the image. We charge credits right when the request is made.

If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.

Example:

50