How To Use

What You Need

Before you send a generate request, you need two things:

Open the design or template in Pixy, then use the Copy design id action in the editor.

Open the Pixy dashboard and choose the design or template you want to use.

Use that ID in the request URL:

POST /api/v1/{designId}/generate

Once the design is open in the editor, select the element you want to modify and use Copy element id. Typical targets include:

Text elements

Use these when you want to change text content, fill color, or stroke color.

Image elements

Use these when you want to swap the source image, or change stroke color.

SVG and shape elements

Use these when you want to change fill or stroke color.

Review the full Modifications guide for the supported fields, examples, and combinations.

Pixy renders the design and returns one or more generated image URLs:

{
  "urls": [
    "https://assets.example.com/generated/design-output-1.png"
  ]
}