API Documentation

Image Processing API Documentation



For new subscribers joining Pixelixe after March 21th 2021, access the more recent V2 documentation here. For older subscribers, don't worry, this V1 documentation will remain supported and active indefinitely. Get more detail regarding the new V2 release and upgrade prerequisites here.

Manipulate and transform images and photos, from your webapp in real time with our easy to use APIs.

Introduction :
To plug into the power of Pixelixe.com API you need to Sign Up for Pixelixe API plan and obtain your unique API Key. You will find those in your dashboard as soon as you subscribes. Once you have set-up your Account, you can start using all Image processing API in your applications.


Supported image type :
  • jpeg
  • png
  • bmp
  • tiff
  • gif

Discover our Image Processing APIs below






Code Snippets to call Image Processing API

First, replace YOUR_API_KEY with your own API key (accessible from your main dashboard).

N.B: Code Snippets below are based on the "Blur" Image API.


        fetch('https://studio.pixelixe.com/api/blur/v1?apiKey=YOUR_API_KEY&value=3&imageUrl=https%3A%2F%2Fpixelixe.com%2Fdocs%2Fimage-processing%2Fimage-processing-api.jpeg').then(response => response.blob())
          .then(myBlob => {
                var reader = new FileReader();
                reader.readAsDataURL(myBlob); 
                reader.onloadend = function() {
                    var base64Image = reader.result;       
                    console.log(base64Image);
                    document.querySelector("#generated-image").src = base64Image; 
                }   
          }).catch((error) => {
          console.error('Error:', error);
        });
import requests

def main():
    r = requests.post("https://studio.pixelixe.com/api/graphic/automation/v1", data={ "json": '{ "template_name": "Demo-image-automation", "api_key": "YOUR_API_KEY", "modifications": [ { "name": "text-0", "type": "text", "text": "THIS IS" }, { "name": "text-1", "type": "text", "text": "A reusable Template" } ] }'})

    print(r.status_code, r.reason)
    file = open("automated_image.png", "wb")
    file.write(r.content)
    file.close()

if __name__ == "__main__":
    main()
curl -X GET 'https://studio.pixelixe.com/api/blur/v1?apiKey=YOUR_API_KEY&value=3&imageUrl=https%3A%2F%2Fpixelixe.com%2Fdocs%2Fimage-processing%2Fimage-processing-api.jpeg'