Skip to main content
Version: V2

Upscaler

POST 
/v2/artworks/upscaling

Upscale an image to a higher resolution. Returns a task ID you can poll, or wire a webhook to get notified when the upscaled image is ready.

Request​

Body

required

    imageUrl urirequired

    The URL of the image. The image's total area (width × height) must not exceed 1,478,656 pixels (e.g., 1216 × 1216). Accepted image formats: JPEG, JPG, PNG, and WebP.

    scaleFactor integer

    Possible values: >= 2 and <= 8

    Default value: 2

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion. Must be HTTPS and a publicly routable host — loopback, link-local, private, and cloud-metadata addresses are rejected.

Responses​

Response indicating that the artwork was successfully created.

Schema

    id uuidrequired
    artworkType stringrequired

    Possible values: [upscaling_v2]

    parameters

    object

    required

    imageUrl uri

    The URL of the image. The image's total area (width × height) must not exceed 1,478,656 pixels (e.g., 1216 × 1216). Accepted image formats: JPEG, JPG, PNG, and WebP.

    scaleFactor integer

    Possible values: >= 2 and <= 8

    Default value: 2

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion. Must be HTTPS and a publicly routable host — loopback, link-local, private, and cloud-metadata addresses are rejected.

    duration numberrequired
    results string[]required
    status stringrequired

    Possible values: [starting, processing, succeeded, failed, canceled]

    createdAt date-timerequired
Loading...