Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pixy.art/llms.txt

Use this file to discover all available pages before exploring further.

Optional parameters can be passed alongside the required embedKey and launch source. They are set per editor launch.

​
saveButtonLabel

Use saveButtonLabel to change the embedded editor’s save button text for your workflow. This is optional. The label is limited to 32 characters. Longer values are truncated. 
window.Pixy.mount('#pixy', {
  embedKey: 'YOUR_EMBED_KEY',
  designId: 'YOUR_DESIGN_ID',
  saveButtonLabel: 'Schedule',
  onExport: (result) => {
    console.log(result.designId)
    console.log(result.files)
  },
})
If saveButtonLabel is omitted, the editor uses Export.

​
imageUrls

Use imageUrls to upload images into the editor as soon as it opens. Pixy uploads each URL into the embed organization’s media library and inserts it onto the canvas, the same way user-uploaded images are inserted. You can pass up to 2 absolute http or https image URLs. imageUrls must be an array. Additional URLs are ignored. 
window.Pixy.mount('#pixy', {
  embedKey: 'YOUR_EMBED_KEY',
  imageUrls: [
    'https://example.com/product-front.png',
    'https://example.com/product-back.png',
  ],
  onExport: (result) => {
    console.log(result.designId)
    console.log(result.files)
  },
})
The image URLs are uploaded when the editor loads. If an image URL cannot be fetched or is not a supported image type, the upload fails and the editor remains open. When you open a blank editor with imageUrls and omit width and height, Pixy uses the first image’s dimensions for the new canvas.

​
userId

Use userId to associate the opened or newly created design with a user from your app. This is optional. This is not a Pixy user id and does not need to exist in Pixy. It is stored as embed metadata on the design. The value is limited to 128 characters. Longer values are truncated. 
window.Pixy.mount('#pixy', {
  embedKey: 'YOUR_EMBED_KEY',
  userId: 'YOUR_APP_USER_ID',
  designId: 'YOUR_DESIGN_ID',
  onExport: (result) => {
    console.log(result.designId)
    console.log(result.files)
  },
})
Use the same optional userId value when listing designs through the Automation API. 
GET /api/v1/designs?userId=YOUR_APP_USER_ID
Authorization: Bearer YOUR_API_KEY
If userId is omitted, the design is still saved and can still be listed without a user filter.