Super resolution

Super Resolution API

To increase your images resolution and quality, the super resolution API is available at https://clipdrop-api.co/super-resolution/v1. The request must be an http POST and its body must be a multipart/form-data that has one image file and a scale:

image_file is the original image to process.
- The original image should be a PNG or a JPEG file, with a maximum resolution of 4 megapixels and a max file size of 20 Mb.
upscale is the desired upscale factor of the result image, valid values are 2 or 4.

In case of success:

the response body will contain the super resolution image in png format if the original image has an alpha layer, as a jpeg if it does not have an alpha layer.
response mime type will be image/[png/jpeg].
the response headers will include a x-remaining-credits property to tell you how many credits you have left.

In case of an error:

the response mime-type is application/json, the error type is indicated by the response status code and details are in the json body, ie

{ "error": "No api key provided" }

Authentication

Requests are authenticated with an API key. If you do not have one, you can get one here.

If your key has leaked, you can revoke it and request a new one in your account page.

Credits

1 successful super resolution API call = 2 credits.

Once logged in, you can claim 100 free ClipDrop APIs credits that you can use for development and debugging purposes. Once the 100 images have been consumed, further calls will be rejected.

If you need more credits, you can purchase packs of 500 to 50 000 credits.

Quota / Rate limiting

By default, each API key has a limit of 60 requests per minute for the super resolution API. Please let us know if you'd like higher values.

Examples

CURL
JavaScript
Python
Swift
Kotlin

curl -X POST https://clipdrop-api.co/super-resolution/v1 \
     -H 'x-api-key: YOUR_API_KEY' \
     -F image_file=@car.jpg \
     -F upscale=2 \
     -o result.jpg

const form = new FormData()
form.append('image_file', photo)
form.append('upscale', 2)

fetch('https://clipdrop-api.co/super-resolution/v1', {
  method: 'POST',
  headers: {
    'x-api-key': YOUR_API_KEY,
  },
  body: form,
})
  .then(response => response.arrayBuffer())
  .then(buffer => {
    // buffer here is a binary representation of the returned image
  })

import requests

r = requests.post('https://clipdrop-api.co/super-resolution/v1',
  files = {
    'image_file': ('car.jpg', image_file_object, 'image/jpeg'),
    },
  data = { 'upscale': 2 },
  headers = { 'x-api-key': 'YOUR_API_KEY'}
)
if (r.ok):
  # r.content contains the bytes of the returned image
else:
  r.raise_for_status()

import Alamofire;

let imageData = try Data(contentsOf: inputPath)

let headers: HTTPHeaders = [
    "x-api-key": "YOUR_API_KEY"
]

AF.upload(
    multipartFormData: { multipartFormData in
      multipartFormData.append(
        imageData,
        withName: "image_file",
        fileName: "car.jpg",
        mimeType: "image/jpeg"
      )
      multipartFormData.append(
        2,
        withName: "upscale"
      )
    },
    to: "https://clipdrop-api.co/super-resolution/v1",
    headers: headers
  )
  .responseData(queue: .global()) { response in
    switch response.result {
        case .success: do {
          // response.data here is an in memory byte buffer of the returned image
        }
        case let .failure(error): print(error)
    }

// this example uses the OkHttp library
// https://square.github.io/okhttp/
val client = OkHttpClient()

val requestBody =
    MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        .addFormDataPart(
            "image_file",
            "car.jpg",
            File("docs/images/car.jpg").asRequestBody("image/jpeg".toMediaType())
        )
        .addFormDataPart("upscale", 2)
        .build()

val request =
    Request.Builder()
        .header("x-api-key", "YOUR_API_KEY")
        .url("https://clipdrop-api.co/super-resolution/v1")
        .post(requestBody)
        .build()

client.newCall(request).execute().use { response ->
    if (!response.isSuccessful) throw IOException("Unexpected code $response")
    // response.body().bytes() here is a byte array of the returned image
}

Responses

The result image, e.g.

  Request is malformed or incomplete, non exhaustive causes can be:
    - Missing image_file in request
    - Input image format is not valid
    - Image resolution is too big

Missing api key.

Your account has no remaining credits, you can buy more in your account page.

Invalid or revocated api key.

Too many requests, blocked by the rate limiter.
You should space out your requests in time or contact us to increase your quota.

This may be a bug on our side.
Please contact us at contact@clipdrop.co so that we can investigate.

Examples of input and outputs

Input

Output

Support

Any question ? Contact us at contact@clipdrop.co or join the Slack community.

Super resolution