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.

​
Embed Dashboard

Embed behavior is configured in Pixy, not with extra iframe attributes. Open the Embed dashboard to save your default logo, accent color, behavior settings, and sidebar visibility.

​
Settings

You can configure:
  • allowed domains
  • title
  • logo
  • accent color
  • launch mode
  • sidebar items
Use the Embed page in Pixy to decide which editor sections stay visible:
  • templates
  • text
  • images
  • elements
  • draw
  • ai
  • uploads
  • brandKit
  • background

​
Launch Scenarios

Use SDK options to choose the design behavior for each launch:
  • designId opens the existing design
  • designId with openAsCopy: true creates and opens a new copy from that design
  • width and height creates and opens a new blank design
  • saveButtonLabel customizes the embed export button text for that launch, up to 32 characters
  • userId optionally stores your app’s user identifier on the design, up to 128 characters, so you can list designs for that user later
Public template IDs returned by the Templates API cannot be opened directly in Embed. Use those IDs with openAsCopy: true so Pixy creates an editable design copy for the embed organization. For the full behavior details and implementation examples, see How to use.