Pixelixe releases new V2 API easier to integrate
We are really glad today to release a new version of our API (V2). During the past months, we gathered a lot of feedback from existing users and thought it was time to upgrade the way our “White-label” editor can be integrated into websites and also to simplify how the Image Automation API can be combined with the editor.
Use the V2 announcement as historical integration context
This March 2021 release note explains the document and user identifiers introduced at that time. It is not a complete current API contract or an entitlement to unlimited generation. Check the current documentation, account configuration and plan before implementing a production integration.
Keep three responsibilities separate: creating a design, associating it with the correct user and rendering an output from approved values. A document identifier is a reference to a stored design; it does not independently prove that a caller is allowed to access another customer’s document.
For an integration trial, create a test design, save its identifier and change one supported field. Check the returned output, the association with the test user and the error returned for a missing or invalid reference. Store application credentials on the server and use non-sensitive test values.
Use the original editor introduction for background, the campaign production handover for input validation and the application review checklist for integration responsibilities. The image generation API page and embedded editor page describe the two product entry points.
Practical guidance revised November 2, 2026. Examples are illustrative.
A lot of improvement have been made, here is a description of the main changes.
Introducing document UID
Starting from the V2 version of our API, each Document created by you or your users are now stored and hosted (direct URL generated for each of your Document) on Pixelixe platform. No need for you to store Documents on your server and to re-expose them to their users.
With V2, each API generating a Document will return a document_uid (Unique Identifier) and a direct URL link to access it.
The document_uid identifies the stored design used for generation; available operations and usage are subject to the current API contract and plan, rather than an unlimited-generation entitlement.
Introducing user UID
To identify who created what, you can now pass along each white label editor opening a user_uid parameter. This uid will be stored alongside the document_uid and will be sent back to you when redirecting the editor to your website to let you match created Document with users.
Introducing document search API
The Search Document API returns by default all documents attached to your account (created either by you or your users or either only yours or only theirs). This API can also be used to retrieve a specific Document using the document_uid parameter. Of course, you can also retrieve all documents created by a specific customer using the user_uid parameter.
New plans
At the March 2021 release, the business model changed and the announcement described 3 plans “Startup”, “Business” and “Enterprise”. Indeed, most of our operating cost with the V1 was processing cost (based on image, PDF, etc generation). Now, as we store each Document in our platform, our operating cost increased a lot. Therefore, we decided to update our business model removing the “API call” notion replacing it with a more easier to understand “Document generation” option (processing & hosting included).
Upgrade from V1 to V2
If you subscribe before March 21th 2021 and want to upgrade your existing account from the previous version to the new V2 release: Please contact the Pixelixe team at inquiries@pixelixe.com to request the upgrade. As described in the “New Plans” section above, as our operating cost are increasing with the new storage and hosting features, API calls attached to your account won’t be effective anymore. A fair plan based on “Document Generation” (new business model) will be proposed to you by our team.
