The <recipe> XML element is the root container for describing a complete embroidery design or preview. It describes the placement, decorations, and desired output settings.
XML structure
<recipe> <!-- Root element: design recipe -->
<location ... /> <!-- Placement and positioning -->
<decorations ... /> <!-- List of design decorations -->
<output ... /> <!-- Output options and format -->
</recipe>
Components
The <recipe> is the root element containing all the data required to generate or preview a new embroidery design. Its flexible format allows detailed control over placement, design components, and final output. It consists of three main parts:
| Element | Description |
| <location> | Defines where the design is placed, positioned, or transformed on the hoop or workspace. |
| <decorations> | Describes the actual embroidery elements — lettering, monograms, team names, ornaments, and any recoloring instructions. |
| <output> | Specifies output options for the generated design or TrueView™ image. This includes format, file type, and additional rendering preferences. |
Usage
A <recipe> XML is required as input for the following APIs: