Skip to main content

Overview

Use the Pixy embed when you want users to open the editor directly inside your app. You can:
  • open a saved design by designId
  • start blank with custom dimensions
  • launch inline or in a modal overlay
  • control downloads, allowed domains, accent color, and visible sidebar items from Pixy

Open An Existing Design

Pass both embedKey and designId in the URL when you want the embed to load a specific design.
<iframe
  src="https://app.pixy.art/embed/editor?embedKey=YOUR_EMBED_KEY&designId=YOUR_DESIGN_ID"
  width="100%"
  height="720"
></iframe>

Open A Blank Editor

Pass embedKey, width, and height when you want to start from a blank canvas. This creates a new project for the embed organization each time it is opened.
<iframe
  src="https://app.pixy.art/embed/editor?embedKey=YOUR_EMBED_KEY&width=1080&height=1350"
  width="100%"
  height="720"
></iframe>

Open In A Modal

Use the Pixy launcher script when you want the editor to open in a modal overlay instead of rendering inline.
<script src="https://app.pixy.art/embed/sdk"></script>
<button id="open-pixy-editor">Open editor</button>
<script>
  const pixyEmbed = window.PixyEmbed.create({
    embedKey: 'YOUR_EMBED_KEY',
    designId: 'YOUR_DESIGN_ID',
    mode: 'modal',
    onExport: (result) => {
      console.log(result)
    },
  })

  document
    .getElementById('open-pixy-editor')
    .addEventListener('click', () => pixyEmbed.open())
</script>
onExport receives the exported files from the editor, so your app can decide what to do next without relying on a direct browser download flow.

Embed Configuration

Embed behavior is configured in Pixy, not with extra iframe attributes. Save these settings in the Embed page inside Pixy:
  • allowed domains
  • title
  • logo
  • accent color
  • launch mode
  • sidebar items
  • downloads
Use the Embed page in Pixy to decide which editor sections stay visible:
  • templates
  • text
  • images
  • elements
  • draw
  • ai
  • uploads
  • brandKit
  • background

Allowed Origins

Allowed domains are checked before the embed editor loads.
  • Add one domain per line in the Pixy Embed page.
  • Leave the list empty if you do not want domain restrictions.

Manage Embed Settings In Pixy

Open the Embed dashboard to save your default logo, accent color, behavior settings, and sidebar visibility.