EWA design recipe

EWA design recipe

The <recipe> 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>

<recipe>
      <location width="100.0" height="100.0" />
      <decorations>
            <design file="logo1.emb" />
            <lettering>
                  <simple_lettering text="TEAM" />
            </lettering>
      </decorations>
      <output format="png" />
</recipe>

This defines:
  1. A 100mm x 100mm embroidery area
  2. A logo and a line of text
  3. Output as a PNG image

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
Defines where the design is placed, positioned, or transformed on the hoop or workspace.
Describes the actual embroidery elements — lettering, monograms, team names, ornaments, and any recoloring instructions.
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:
  1. api/newDesignTrueview
  2. api/newDesign
  3. api/newLetteringPreview
Info
At least one decoration is required. For api/newLetteringPreview, you must use exactly one lettering in <decorations>.

XML elements

The <recipe> structure can include or reference the following detailed XML elements, depending on design requirements. Always refer to the specific sub-element documentation for exact attributes and valid values:
Element
Purpose
Defines positioning and transformations.
Lists all decorative elements.
Handles scaling, rotation, or flipping.
Specifies thread colors and types.
Embeds additional design components.
Controls rendering output.
Defines lettering parts of the design.
Defines monogram elements.
Provides recoloring instructions.
Used for customized personalized lettering.
Used for customized personalized lettering.
Used for customized team lettering.
Used for customized team lettering.
Used for customized team lettering.
Used to define monogrammed lettering and ornament details.
Used to define monogram lettering details.
Used to define monogram ornament details.
Specifies file type, naming, and output control.

    • Related Articles

    • EWA API getting started

      These notes guide developers through the initial setup, authentication, API calling structure, and development tools available for integrating the Wilcom Embroidery Web API into web applications. ✅ Step 1: Sign up and get API credentials Visit the ...

    • EWA API technical notes

      Wilcom’s Embroidery Web API is a cloud-hosted, RESTful interface that enables developers to integrate professional embroidery design and personalization features into websites, e-commerce platforms, or internal systems. The API supports rendering, ...

    • EWA API capabilities

      Wilcom’s Embroidery Web API (EWA) provides a RESTful interface for integrating advanced embroidery capabilities into web and cloud-based applications. The API exposes functionality for rendering, modifying, and generating embroidery designs using ...

    • EWA API business case

      In today’s fast-paced, personalization-driven market, embroidery businesses and e-commerce platforms must offer instant customization, real-time previews, and automated production workflows. The Wilcom Embroidery Web API (EWA) is a robust, ...

    • Design Library is missing/not displayed in ES 2025

      ISSUE: The Design Library is missing or not displayed. In ES 2025, after clicking Design Library icon, all you can see are your design thumbnails. Solution: 1. Set your monitor/display resolution to 100% [recommended] 2. If after doing so, and the ...