Pixlr API

You are here:
< Back

The Pixlr API enables you to embed Pixlr web applications on your own site. Many advanced photo editing features available on Pixlr.com can easily be added to your site with the API. Using the API is completely free and does not require a commercial license (nor do we offer one).

Using the Pixlr Web API

The /editor and /express pages take special parameters either as querystring or form parameters. You don’t have to do anything special to get the application to recognize the parameters as we check for them on every request.

Javascript library

Our javascript library (below) is a great resource for quick and simple API implementation.

We also have a site with examples on how to use the js library: developer.pixlr.com

You can download the entire javascript library here.

In parameters (what you send to us)

Name Description
referrer The name of the referring service for example “Your site name” or “Facebook”
icon A url to a 16*16 icon to be shown at the save tab
exit The URL to send the visitor if the user click exit/close
image A URL to the image or the post raw data of the image to open
title The title of the opened image
type The filetype of the image, just type no “.”, the apps will try to get the type from the URL if type param is not provided.
method The way we send the image information, “GET” or “POST”, default is “GET”

If you set this to POST then you have to have a crossdomain.xml in the root of your web application. And you need to add pixlr.com to the list of valid domains (or just copy ours)

target The URL to which we send the image information when saving
redirect Set to “false” if you don’t want the browser to follow the save post. (i.e the user stay in the editor after saving.)
locktarget Remove the possibility for the user to “save to computer” and other service in Pixlr Editor
locktitle Lock the image title so the user can’t change it
locktype Lock the save format, values are jpg, png, bmp, pxd or source, do not include “.”
quality Set the jpg quality when the user saves the image, values are 0-100
copy Shows a checkbox on the save dialog that lets the user select “Save as copy”
maxwidth Set the maximum width of an image the user saves
maxheight Set the maximum height of an image the user saves
wmode (Advanced) Change the flash wmode (transparent, opaque, window etc) when you need to use z-index and float HTML over the flash area


Out parameters (what we send to you)

Name Description
image The content of this parameter depends on the value of the “method” in-parameter.

If method was GET the value of image is an url to where we saved the image.

If method was POST the value of image is the actual image.

title The title of the image the user typed in when saving.
type The type of image can be: jpg, png, bmp or pxd.
state The state of the image, can be “new”, “copy”, “replace”. New is when the user open/creates the image in the editor. Copy is when the image is from the API and the image checked “Save as copy”.

Pixlr document format

The Pixlr file format (*.pxd) is a compressed binary format designed to enable layered files to be saved quickly, at high-quality and smaller file sizes.

The .pxd file is compressed with zlib to reduce the file size. The uncompressed data is then ordered into two main sections: the header and the layer sections. The header includes, pxd version, color-mode, width, height and number of layers.

Pixlr applications

Today we have four applications in our family of products:

  • Pixlr (formerly Pixlr Express) will meet the needs of most photo enthusiasts, and is available for your Windows or Mac Computer, or iPhone or Android Smartphone. Pixlr is also available for use in your browser at www.pixlr.com. This app is built in Flash and requires the Flash plug-in to work.
  • Pixlr Editor is great for photo enthusiasts who are looking for a sophisticated photo editor and is available for use in your browser at www.pixlr.com. This app is built in Flash and requires the Flash plug-in to work.
  • Pixlr-o-matic is designed for photo enthusiasts who want to make quick fixes and share their photos fast. Pixlr-o-matic is available for your iPhone and Android smartphone and in your browser at www.pixlr.com. This app is built in Flash and requires the Flash plug-in to work.
  • Google Chrome fans will enjoy editing their photos with Pixlr Touch Up. Put the finishing touches on your photos with this free offline photo editor from Autodesk. Automatically remove unwanted details from your photos so it looks like they were never there. Pixlr Touch Up includes all your essential editing tools including crop, resize, rotate, effects, and more. You can also open and save files directly to and from Google Drive. Visit the Google Chrome Web Store to download Pixlr Touch Up. This app is not built in Flash. It uses WebGL and is ideal for Chromebook users.

Are user images kept private?

Yes. Images edited with our online applications are opened directly from the user’s computer into our online application. We don’t see them in any way, and they don’t leave the computer. Images edited using embedded versions of a Pixlr online applications are temporarily stored on our servers but deleted after 5 minutes.

Can I embed the Pixlr online applications into my own website?

We know that a many people love our software and want to use it on their own sites. It’s free, just go to the API page and go for it!

Pin This!