Introduction

Welcome to the Pixelixe API! Pixelixe APIs enables you to enhance your webapp with automated image generation and customizable graphic editing tool.

Pixelixe offers end to end solutions for manual or automated image generation.

1. Our white-label editor and APIs can easily be integrated into any webapp to let your visitors and users create, search, update, delete their own documents (designs) and push them wherever you need them in real time.

2. Additionally, any document generated from the editor can become an API. Thanks to our powerful "Image Automation API", your app can generate unlimited variation of graphics on the fly (social media content, banners, etc..).

Authentication

To test your API key:

curl "https://studio.pixelixe.com/api/authentication/v2" \
  -H "Authorization: Bearer api_key"

The above endpoint returns JSON structured like this:

{
    "status": "success",
    "message": "Authenticated successfully"
}

Make sure to replace api_key with your API key.

Pixelixe uses API keys to allow access to the API. You can get an API key by creating an account in Pixelixe.

Pixelixe expects the API key to be included in all API requests to the server.

1. For the front-end API such as the insertion of the editor into your webapp, using the public API Key is strongly recommended. This public API key is accessible from your Pixelixe back-office.

2. For back-end APIs (every other API), the API key can be set up in a header that looks like the following:

Authorization: Bearer api_key

Editor API

Documents are the reusable designs that are created and saved from the Pixelixe editor. Documents can be anything you need them to be: banners, social media graphics, email images, custom sized content, etc. Documents can be exported in either PNG, JPEG, HTML or PDF.

You or your users can design a Document using the Pixelixe editor, of course, but you can also use Documents as reusable templates. For example to offer and list custom clickable preset templates on your website for your customers or even more if you want to automatically generate variations of your graphics and images with our API.

Basically, every Document can become an API. Every text, color and image in a Document (aka template) can be modified via our API on the fly!.

Customize your white-label editor

The Pixelixe platform provides an easy to use Customization tool (no code required). To get started, log in to access your Pixelixe dashboard. From the Dashboard, select the "White label Editor API" section from the left or central panel. Then, you will be asked to "Customize your editor".

Search Documents

curl "https://studio.pixelixe.com/api/document/search/v2?document_uid=32f59312815640e186cf17fe3fd5c1d9" \
  -H "Authorization: Bearer api_key"

The above endpoint returns JSON structured like this:

{
   "api_key": "3r3C7FAmlofEdsVLlp8EsGM6MdD3",
   "documents": [
      {
         "name": "Demo-template-1",
         "width": 600,
         "height": 600,
         "document_uid": "32f59312815640e186cf17fe3fd5c1d9",
         "last_modification_date": "03-08-2021_20:38:21:579",
         "public_png_url": "https://studio.pixelixe.com/storage/file/32f59312815640e186cf17fe3fd5c1e8/Demo-template-1-03-08-2021_20%3A38%3A21%3A579.png",
         "public_html_url": "https://studio.pixelixe.com/storage/file/32f59312815640e186cf17fe3fd5c1e8/Demo-template-1-03-08-2021_20%3A38%3A21%3A579.html",
         "available_modifications": {
            "modifications": [
               {
                  "name": "background-image",
                  "image_url": "Change the background image using any URL here",
                  "width": "916.328px",
                  "height": "600px",
                  "visible": "true"
               },
               {
                  "name": "text-1",
                  "type": "text",
                  "text": "Some text example that can be modified",
                  "color": "rgb(0, 0, 0)",
                  "font-size": "108px",
                  "visible": "true"
               },
               {
                  "name": "icon-3",
                  "type": "icon",
                  "color": "rgb(0, 0, 0)",
                  "visible": "true"
               }
            ]
         }         
      }
   ]
}

This endpoint either retrieves all Documents attached to your Pixelixe account (with no parameter) or can be used with an optional parameter as described below.

HTTP Request

GET https://studio.pixelixe.com/api/document/search/v2

Optional Query Parameters

Create or Update a Document

- Example 1: Open with the image editor mode

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&allowUploadOnly=true" >
</iframe>

The above HTML code will ask users to start uploading their own image.

- Example 2: Open an image from a URL

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&imageUrl=https://any-website.com/any-image.png" >
</iframe>

The above HTML code will embed your customized (white-label) editor into your website and open the following image https://any-website.com/any-image.png.

- Example 3: Create a blank Document (with custom size)

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&width=1000&height=300" >
</iframe>

The above HTML code will embed your customized (white-label) editor into your website and open blank canva with the following size: width: 1000px & height: 300px.

- Example 4: Offer your own templates (saved graphic) to your users

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&customTemplates=true&allowCustomFormat=false" >
</iframe>

The above HTML code will automatically displayed your saved documents (as templates).

- Example 5: Open and update an existing Document

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&document_uid=32f59312815640e186cf17fe3fd5c1d9" >
</iframe>

The above HTML code will embed your customized (white-label) editor into your website and open an existing Document with the following uid: 32f59312815640e186cf17fe3fd5c1d9.

- Example 6: Open with the PDF editor mode

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&pdf=true&pdfMargin=20&width=1000&height=1000" >
</iframe>

The above HTML code will embed your customized (white-label) editor into your website and open a blank canva with the following size: width: 1000px & height: 300px ready to be exported as PDF with a margin of 20 px.

- Example 7: Open the editor translated in Portuguese

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&lang=po" >
</iframe>

The above HTML code will embed your customized (white-label) editor into your website and open the editor translated in Portuguese.

- Example 8: Overwrite your server endpoint (webhook_url) - Convenient for integrating in your Dev or staging envs

<iframe
    width="1200"
    height="1080"
    allowfullscreen
    frameborder="0"
    src="https://studio.pixelixe.com/#api?apiKey=api_key&webhook_url=https://staging.yourdomain.com/endpoint" >
</iframe>

This will overwrite your configured and saved webhook_url (Recommended only to run tests & QA).

Editing a Document can be done using the Pixelixe graphic and image editor. Pixelixe offers a free online editor available to anyone at https://studio.pixelixe.com/.

This editor can be configured and customized by subscribers from their account (no-code required), and then be integrated into any website using an IFRAME. (iframes are HTML elements that can be inserted anywhere within a webpage layout or fullscreen)

Opening the editor: Integrate the editor into your website with an IFRAME

https://studio.pixelixe.com/#api?apiKey=public_api_key

WARNING : The minimum iframe width to display the editor is 1000 px (pixels).

Optional Parameters

Get edited Document on your server using WebHook

As soon as your user will have finish editing their document clicking on the "call-to-action" button the following JSON payload will be pushed to your server endpoint (webhook_url):

{
   "status": "success",
   "created_at": "03-13-2021_20-1-23-812",
   "user_uid": "7r3C7FAjaofE4sVLyp5EsGM6MdD3",
   "width": 200,
   "height": 200,
   "public_png_url": "https://studio.pixelixe.com/storage/file/1fd7502e4dc3a3ddba65294f66ecf2b6/fa2d67146931484f09be18995b731501/image-03-13-2021_20-1-23-812.png",
   "public_html_url": "https://studio.pixelixe.com/storage/file/1fd7502e4dc3a3ddba65294f66ecf2b6/fa2d67146931484f09be18995b731501/document-03-13-2021_20-1-23-812.html",
   "document_name": "Untitled",
   "document_uid": "fa2d67146931484f09be18995b731501"
}

Within the editor, your users will be invited to click on a call-to-action button (top right corner of the editor) as soon as they will have finished editing their Document. Keep in mind you can rename this "call-to-action" button yourself from the "Customization tool" accessible from your Pixelixe account.

From your Pixelixe account, you can configure your white-label editor to decide whether you prefer to get created and edited Document pushed to your server endpoint (WebHook URL) or sent to your email INBOX.

If you define your WebHook URL (your server endpoint), each time a user click on the "call-to-action" button you will receive in real time an HTTP POST request contaning direct URLs of the edited graphic (PNG and HTML) within a JSON payload. Discover below an example of the static JSON payload that will be pushed on your server endpoint.

{
   "status": "success",
   "created_at": "03-13-2021_20-1-23-812",
   "user_uid": "7r3C7FAjaofE4sVLyp5EsGM6MdD3",
   "width": 200,
   "height": 200,
   "public_png_url": "https://studio.pixelixe.com/storage/file/1fd7502e4dc3a3ddba65294f66ecf2b6/fa2d67146931484f09be18995b731501/image-03-13-2021_20-1-23-812.png",
   "public_html_url": "https://studio.pixelixe.com/storage/file/1fd7502e4dc3a3ddba65294f66ecf2b6/fa2d67146931484f09be18995b731501/document-03-13-2021_20-1-23-812.html",
   "document_name": "Untitled",
   "document_uid": "fa2d67146931484f09be18995b731501"
}

Delete a Specific Document

curl "https://studio.pixelixe.com/api/document/delete/v2?document_uid=32f59312815640e186cf17fe3fd5c1d9"
  -H "Authorization: Bearer api_key"

The above endpoint returns JSON structured like this:

{
   "status": "success",
   "message": "Document deleted."
}

This endpoint deletes a specific Document.

HTTP Request

https://studio.pixelixe.com/api/document/delete/v2

URL Parameters

Image Automation API

curl "https://studio.pixelixe.com/api/graphic/automation/v2"
  -d json

• Example of a JSON Payload to POST to the above endpoint

{
  "document_uid": "32f59312815640e186cf17fe3fd5c1d9",
  "api_key": "afvkwxFgNSReMbYoCvFi0UkMFPP1z", 
  "format": "json",
  "custom_field": "WHATEVER_YOU_WANT",
  "modifications": [
    {
      "element_name": "background-image",
      "image_url": "https://any-website.com/img/any-image.jpg",
      "width": "cover",
      "height": "cover",
      "visible": "true"
    },    
    {
      "element_name": "text-0",
      "text": "Enter custom text here",
      "color": "red",
      "font-size": "12px",
      "visible": "true"
    },
    {
      "element_name": "icon-0",
      "color": "#e2e2e2",
      "visible": "false"
    },
    {
      "element_name": "shape-0",
      "background-color": "red",
      "border-color": "red",
      "border-size": "12px",
      "visible": "true"
    }
  ]
}

The above endpoint returns JSON structured like this:

{
   "status": "success",
   "created_at": "03-13-2021_20-1-23-812",
   "image_url": "https://studio.pixelixe.com/storage/file/1fd7502e4dc3a3ddba65294f66ecf2b6/fa2d67146931484f09be18995b731501/image-03-13-2021_20-1-23-812.png",
   "uid": "32f59312815640e186cf17fe3fd5c1d9"
}

Pixelixe Image Automation API enables you to auto-generate images such as social media visuals, ecommerce banners and more based on your saved Document (See section above). For this section, think of Documents as reusable templates and discover how to create unlimited variations of your Documents with a simple JSON-based API.

Every text and image in a Documents becomes an object you can modify via API. Simply hit the Image Automation API endpoint with your modification requests and in a few seconds an image will be generated and sent to your endpoint.

HTTP Request

https://studio.pixelixe.com/api/graphic/automation/v2

POST Parameters

Send as a JSON object

Format options

Define the expected output format. The format property can be either image (by default), json, base64, pdf

Modifications Array

Your Image Automation payload should contain a parameter named modifications which is an array of modifications you would like to apply to a template.

All properties are optional, for example if you do not specify a color, the object's default color will be used. If your element_name is not found in the Document, expected modifications for this element will be ignored.

Code Snippets

Javascript Code Snippets:

fetch('https://studio.pixelixe.com/api/graphic/automation/v2', {
    method : "POST",
    body: '{ "document_uid": "32f59312815640e186cf17fe3fd5c1d9", "format": "image", "api_key": "6nm3JE0GoVWUai2wNEWiTLF66rk1", "modifications": [ { "element_name": "text-0", "type": "text", "text": "THIS IS" }, { "element_name": "text-1", "type": "text", "text": "A reusable Template" } ] }'
}).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);
});

Python Code Snippets:

import requests

def main():
    r = requests.post("https://studio.pixelixe.com/api/graphic/automation/v2", data={ "json": '{ "document_uid": "32f59312815640e186cf17fe3fd5c1d9", "format": "image", "api_key": "6nm3JE0GoVWUai2wNEWiTLF66rk1", "modifications": [ { "element_name": "text-0", "type": "text", "text": "THIS IS" }, { "element_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 Code Snippets:

curl https://studio.pixelixe.com/api/graphic/automation/v2 -d 'json={ "document_uid": "32f59312815640e186cf17fe3fd5c1d9", "format": "image", "api_key": "6nm3JE0GoVWUai2wNEWiTLF66rk1", "base64": "true", "modifications": [ { "element_name": "text-0", "type": "text", "text": "THIS IS" }, { "element_name": "text-1", "type": "text", "text": "A reusable Template" } ] }'

Discover on the right panel some code snippets written in Javascript, Python and Curl to get started with the Image Automation API.

Test Image Automation API (2 clicks)

The Pixelixe platform includes an Image Automation API tester and will auto-generates the JSON payload with its default modifications array.

Click on the "Your Saved documents" menu from the dropdown menu to access the list of your saved graphics & templates. As mentioned before, every document can be automated.

Move your mouse over a graphic and click on the button corresponding to the following tooltip "Automate image generation based on this model".

A pop up will open and display the JSON document required to send modifications demand to the API. You can tune the modifications section of the JSON directly into the popup to generate variations of your image.

Once you are happy with your template, you are free to duplicate this JSON document to ease your API integration process.

Error handling

If no errors occurs, the API will return a (200, 'OK') HTTP status code. If an error occurs, the HTTP response status code will be 400 and the response will be a JSON document with the following structure.

{
   "status": "error",
   "message": "Bad or missing JSON (unexpected structure)"
}

Image Filter API

Follow this link to access the Image Filter API documentation

Apply photo effects and filters to your image with our ready to use API and presets.

Supported image type :

• jpeg
• png
• bmp
• tiff
• gif

Filter list :

• Blur
• Grayscale
• Invert
• Sepia

Follow this link to access the Image Filter API documentation

Image Processing API

Follow this link to access the Image Processing API documentation

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

Supported image type :

• jpeg
• png
• bmp
• tiff
• gif

Processing API list :

• Compress
• Resize
• Crop
• Flip
• Rotate
• Brightness
• Contrast
• Opacify

Follow this link to access the Image Processing API documentation

Deprecated API V1

For users who subscribed before April 2021, the previous documentation V1 is available here Pixelixe docs V1