Skip to main content

image-upscaling.net api client

Project description

image-upscaling-api

A simple Python wrapper for the image-upscaling.net upscaling API.

Installation

pip install image-upscaling-api

Documentation

Examples

1. Basic File Upscaling

  • Uploads an image from disk and saves it back to disk.
  • upscaled by 4x using the "plus" model
  • The upscaler encodes your image as png but you can save it as any opencv supported extension.
from image_upscaling_api import UpscalerAPI

api = UpscalerAPI(client_id="a9898cb899c1542468b8555e59dfa331")

# Upload (scale: 4, model: plus)
img_id = api.upload("baboon.png", model="plus", scale=4, face_enhance=False)

# Download and save as jpg
api.wait_and_download(img_id, save_path="./baboon_upscaled.jpg")

2. OpenCV & Diffuser

  • uses opencv images for upload and download
  • uses diffuser model with fixed output resolution (-1 = 4MPx)
  • no save_path -> image is returned as opencv image
from image_upscaling_api import UpscalerAPI
import cv2

api = UpscalerAPI(client_id="a9898cb899c1542468b8555e59dfa331")

image = cv2.imread("photo1.jpg")

# Upload with diffuser-lite and custom prompt
img_id = api.upload(image, model="diffuser-lite", scale=-1, prompt="", creativity=0.1)

# Download back into numpy array
upscaled = api.wait_and_download(img_id)
cv2.imwrite("upscaled_photo1.png", upscaled)

Github

Find the source code here: [dercodeKoenig/image-upscaling.net_API]

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

image_upscaling_api-2026.0.1.tar.gz (77.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

image_upscaling_api-2026.0.1-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file image_upscaling_api-2026.0.1.tar.gz.

File metadata

  • Download URL: image_upscaling_api-2026.0.1.tar.gz
  • Upload date:
  • Size: 77.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for image_upscaling_api-2026.0.1.tar.gz
Algorithm Hash digest
SHA256 4e22a54628750bbc8ef19cd9fd3b2615cca249ff1dfbeefcfb4b5120b1307d94
MD5 fe2866df80a3c7a06f22eb2970a5595e
BLAKE2b-256 a14498ac7de2c881fcc99eceb57b233335ccd619ee44386132e9de3db60c53e8

See more details on using hashes here.

File details

Details for the file image_upscaling_api-2026.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for image_upscaling_api-2026.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4d4e0122e9b28fd7247f68985d56d6f7b0a7e050e5ae8d6ae9452d8960c71018
MD5 02add0a5e716cd17ee728dcf129c1045
BLAKE2b-256 941cd5ba32552d5f56f3ba105a49582fec960197754977e7477e04873a915d6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page