Generate TrueView for new design

Generate TrueView for new design

The newDesignTrueview API method creates a new virtual embroidery design from a recipe and returns a TrueView image – 1:1 PNG with transparent background. The API also returns design metadata — such as height, width, and stitch count — similar to the api/designInfo response.
Info
The newDesignTrueview API method  does not return the actual embroidery file. You need the api/newDesign method for that.

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 and TrueView™ options. 

XML structure

<xml>
  <recipe>...</recipe>                 <!-- Full recipe: decorations, layout, output -->
  <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 TrueView™ image and the design metadata:

<xml>
  <files>
    <file filename="preview.png" filecontents="..." />     <!-- 1:1 TrueView image -->
  </files>
  <design_info>...</design_info>                            <!-- Metadata about the result -->
</xml>

XML components

ComponentDetails
<recipe>The design is built on-the-fly using the provided <recipe>, including lettering, team names, or any other decorations.
<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. This method is typically used for previewing a design layout before committing to stitch data.
  2. The result image is transparent PNG, named using the trueview_file attribute in the recipe’s <output> section.
  3. If you need to generate the actual embroidery design file, use api/newDesign.
  4. If you only need a preview, use api/newDesignTrueview.

    • Related Articles

    • Design status

      The design status setting allows you to define workflow stages used to track the progress of designs. Status values help teams manage design workflows, from initial request through approval and production. Design statuses are shared across the ...

    • 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 ...

    • 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 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 ...

    • 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 ...