Generate output for modified design

Generate output for modified design

The editDesign API method creates a new design file — e.g. EMB — by modifying an existing design — specifically lettering and monogram objects. Optionally, it outputs a TrueView™ preview (PNG) and returns design metadata — e.g. size, stitch count. This method is the full version of api/editDesignTrueview since it generates the actual embroidery file.

POST parameters

ParameterTypeRequiredDescription
appIdString✅App ID from your Wilcom Developer Portal account.
appKeyString✅App Key from your Wilcom Developer Portal account.
requestXml
String
✅
An XML string specifying the design to edit, output settings, and the source files.

XML structure

<xml>
  <recipe>
    <design ... />  <!-- Existing design definition with updated lettering and monogram properties -->
      <design_file filename="input.emb" />
      <lettering_objects>
        <lettering text="New Text" font="Block" height="12" />
      </lettering_objects>
    </design>
    <output ... />  <!-- Output settings -->
      design_file="updated.emb"
      trueview_file="updated.png"
      format="EMB"
    />
  </recipe>

 <files ... />      <!-- Design file(s) -->
    <file filename="input.emb" filecontents="..." />
  </files>
</xml>

Response

On success, the API returns an XML string containing the generated embroidery design file, and optionally the TrueView™ image and updated design metadata:

<xml>
  <files>
    <file filename="updated.emb" filecontents="..." />     <!-- Modified embroidery file -->
    <file filename="updated.png" filecontents="..." />     <!-- Optional preview PNG -->
  </files>
  <design_info>...</design_info>                           <!-- Metadata like size, stitches -->
</xml>

XML components

Componentn
Details
The design is based on the full <recipe> definition. This is the root container for describing a complete embroidery design or preview.
Existing design definition with updated lettering and monogram properties
<design_file>
Input file is identified in <design_file> and passed in <files>.
Lettering edits go in <lettering_objects>, monograms in <monogram_objects>.
Place custom text with specific style, position, and thread color. 
Specifies the output filename and format. If trueview_file is set, a transparent PNG preview is generated.
This element is used to pass one or more files to or from API endpoints. It contains the input vector file and the resulting design and TrueView™ file(s).
Provides estimated design properties — e.g. size, stitch count — for the generated embroidery file. 

Remarks

  1. The EMB (or other format) file is returned in <files> with a name matching design_file.
  2. For a TrueView image only, use the api/editDesignTrueview method instead.
  3. Supported bitmap formats are listed in Supported formats section of this document.