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.

​
Add Pixy To Your Product

Pixy Embed API lets you launch the Pixy editor inside your app so users can customize designs without leaving your product. Use it when you want users to:
  • open and edit a saved design
  • start from a blank canvas with your chosen dimensions
  • create a new copy from an existing design
  • save exported files back into your product

​
What You Can Build

Render the Pixy editor inline inside your app for a native editing workflow.
Let users start from a design you provide, edit it, and save either the original design or a new copy.
Configure allowed domains, branding, accent color, launch mode, and visible sidebar items from Pixy.

​
How It Works

1

Create embed settings

Open the Embed dashboard in Pixy and configure the domains and editor options your app can use.
2

Add the SDK

Load the Pixy embed SDK in your page.
3

Launch the editor

Mount the editor inline or open it in a modal with your embedKey.
4

Handle saved exports

Use onExport to receive the saved designId and exported file URLs.

​
Where To Go Next

Authentication

Learn how embed keys and allowed origins control access to the embedded editor.

How to use

Add the SDK, launch the editor inline or in a modal, and handle saved exports.

Configuration

Configure branding, launch behavior, and editor sidebar visibility.