Generate embroidery design

Generate embroidery design

The newDesign API method creates a new embroidery design file from a recipe and returns the actual stitch data in EMB format and/or other supported formats. Optionally, it can also generate a transparent TrueView™ preview (transparent PNG) as well as design metadata — dimensions, stitches, colors.

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 full design recipe and its component files. 

XML structure

<recipe>...</recipe>                  <!-- Required: Design components and output settings -->
  <files>
    <file filename="Block1.abc" filecontents="..." />
    <file filename="threadchart.tch" filecontents="..." />
  </files>
</xml>

Response

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

<xml>
  <files>
    <file filename="output.emb" filecontents="..." />       <!-- Main EMB design -->
    <file filename="preview.png" filecontents="..." />      <!-- Optional TrueView™ preview -->
  </files>
  <design_info>...</design_info>                             <!-- Design metadata -->
</xml>

XML components

ComponentDetails
<recipe>The design is based on the full <recipe> definition. This is the root container for describing a complete embroidery design or preview.
<files>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).
<design_info>Provides estimated design properties — e.g. size, stitch count — for the generated embroidery file. 

Remarks

  1. The output.emb is named based on the design_file attribute in the recipe’s <output> block.
  2. If trueview_file is specified in the recipe, a TrueView PNG will also be included in the response.
  3. If you only need a preview, use api/newDesignTrueview.
  4. To inspect existing design files, use api/designInfo.
  5. Supported bitmap formats are listed in Supported formats section of this document.

    • Related Articles

    • Creating production-ready embroidery lettering

      When selling decorated garments online, it’s not enough to simply let customers type in text and place it on a shirt. Unlike printing, embroidery requires fabric-specific settings to produce good stitch quality. The same lettering will need different ...

    • How to resize an embroidery design

      To resize an embroidery design in WilcomWorkspace: Log into WilcomWorkspace. Browse to TrueSizer from the left-side menu 3. Open your embroidery design 4. In the right-side Edit panel, change the Width or Height of the design and press Enter the ...

    • Embroidery files

      By default, WilcomWorkspace saves to its native EMB file format. This format contains all information necessary both for stitching a design and for later modification. When opening designs created or saved in other formats, WilcomWorkspace converts ...

    • Embroidery Connect Device Setup Video

      Click this link to open the Video on how to setup the Embroidery Connect Device Link - Embroidery Connect Device Setup Video

    • Capture design bitmap

      The Capture Design Bitmap feature allows you to create and download a bitmap image of a design stored in Wilcom Library. Bitmap previews are useful for sharing design visuals with customers, including designs in documentation, or referencing designs ...