Image-Upscaling.net API Documentation

This page describes how to interact with the Image Upscaling, Background Removal, and Text-to-Speech APIs. The following Python code samples demonstrate how to use these endpoints.

You can copy this code right into your program and test it out (but change the client id). The daily free quota applies to all requests. You can run this code as a notebook here.

1. Setup

First we need a sample image. I highly recommend you use your own sample image because many people submitting the byte-perfect same image could be seen as suspicious and could lead to a ban of your ip.

!wget https://image-upscaling.net/assets/images/test_image.jpg

The client id always should be included in the headers. This is how you identify yourself. You have to use 32 digits, allowed are: 0-9, a-z, A-Z.
Only when downloading results you can also specify the client id as get parameter (?client_id=76..42)

import requests
import json

serverurl = "https://image-upscaling.net"
client_id = "1234567890asdfghjklqwertzUIOPYXC"
cookies = { "client_id": client_id }

2. Upscaling API

Upload an image

You specify the target scale (1,2,3,4) and whether you want to use the face repair mode or not. Face repair is slower and costs a little more, so only use it if you need it.

use_face_enhance = False
scale = 4
path = "test_image.jpg"

url = "/".join([serverurl, "upscaling_upload"])
data = {"scale": scale}
if use_face_enhance:
    data["fx"] = ""

files = {"image": open(path, "rb")}
response = requests.post(url, data=data, files=files, cookies=cookies)
print(response.text)

Get status

All 3 APIs have an endpoint to query the processing status. They will provide you with the download urls.

url = "/".join([serverurl, "upscaling_get_status"])
response = requests.get(url, cookies=cookies)
print(response.json())

Download processed files

A good way to download all your result files is to query the processing status and download all images that are marked as processed.
When using ?delete_after_download the server will automatically delete your file after you downloaded it. You can repeat this until there are no more files left.

while True:
    url = "/".join([serverurl, "upscaling_get_status"])
    response = requests.get(url, cookies=cookies).json()

    for url in response["processed"]:
        filename = url.split("/")[-1]
        params = {"delete_after_download": ""}
        content = requests.get(url, cookies=cookies, params=params).content
        with open(filename, "wb") as f:
            f.write(content)

    if not response["pending"] and not response["processing"] and not response["processed"]:
        break
    else:
        import time
        time.sleep(1)

3. Background Removal API

This API is almost the same as the upscaling API, it just has different endpoints and no extra data when uploading a file.

Upload an image

url = "/".join([serverurl, "removebg_upload"])
files = {"image": open("test_image.jpg", "rb")}
response = requests.post(url, files=files, cookies=cookies)
print(response.text)

Download results

while True:
    url = "/".join([serverurl, "removebg_get_status"])
    response = requests.get(url, cookies=cookies).json()

    for url in response["processed"]:
        filename = url.split("/")[-1]
        params = {"delete_after_download": ""}
        content = requests.get(url, cookies=cookies, params=params).content
        with open(filename, "wb") as f:
            f.write(content)

    if not response["pending"] and not response["processing"] and not response["processed"]:
        break
    else:
        import time
        time.sleep(1)

4. Text-to-Speech API

Submit text

You need to specify:

• the text you want to process (note that there is a 60k character limit for every request)
• the speed you want as float
• the voice you want (you can find the voices on the main tts page on the website)

url = "/".join([serverurl, "tts_submit"])
data = {
    "text": "This is the text to speech api",
    "voice": "am_michael",
    "speed": 1.1
}
response = requests.post(url, json=data, cookies=cookies)
print(response.text)

Download results

This endpoint returns a list of your requests with a download link for the mp3 files. Your file is ready when "result" is not empty.

while True:
    url = "/".join([serverurl, "tts_get_data"])
    response = requests.get(url, cookies=cookies).json()

    for element in response:
        url = element["result"]
        if url != "":
            print(url)
            params = {"delete_after_download": ""}
            content = requests.get(url, params=params, cookies=cookies).content
            with open(url.split("/")[-1] + ".mp3", "wb") as f:
                f.write(content)

    if not response:
        break
    else:
        import time
        time.sleep(1)

5. Account info

Use this endpoint to get information on your account.

url = "/".join([serverurl, "get_account_info"])
response = requests.get(url, cookies=cookies).json()
print(response)
# {'balance': 0, 'client_id': '1234567890asdfghjklqwertzUIOPYXC', 'email': '', 'ip': '34.68.107.124', 'quota_free': 100, 'quota_used': 0}
  

6. Bonus: change client id in browser

If you want to change client id in browser, you can use

/account?client_id=xxxxx

with a valid client id and it will make the browser switch to the given client id.
The image-upscaling.net app uses this feature.