Authentication

​

Getting Your Test API Key

As soon as you sign up for the IMG Processing API, you will receive a test API key that you can use to make requests to the API. This key is for testing purposes only, since it has a limited rate limit, adds a watermark to the processed images, and images won’t be stored for more than 90 days.

Test images DO NOT count towards your monthly quota, so you can use them to test the API without worrying about your usage, you don’t even need a credit card to start processing images!

You can find your test API key in the API Dashboard.

​

Using Your API Key

To authenticate your requests to the IMG Processing API, you need to include your API key in the x-api-key header of your request. Here is an example of how to do this using curl:

curl -X GET https://api.img-processing.com/v1/images \
  -H "x-api-key: YOUR_API_KEY"
  -H "Content-Type: application/json"

Request that are not authenticated with a correct API key will receive a 401 Unauthorized response.

​

Getting Your Production API Key

Once you are ready to go live with your application, you will need to get a production API key. This key will have a higher rate limit, won’t add a watermark to the processed images, and images will be stored indefinitely, until you delete them.

To get your production API key, you will need to upgrade your account to a paid plan. You can do this in the API Dashboard by clicking Set up Billing.

Once you have set up billing, you will be able to generate a production API key in the same page, by clicking Get Live API Key.

After generating the production API key, it will be displayed on the page. Make sure to copy it and store it securely, as it will not be displayed again. We do not store your API key, so if you lose it, you will need to roll a new one.

​

The Next Steps

Now that you have your API key, you can start making requests to the IMG Processing API. Start by uploading an image and applying some transformations to it!