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.
The newDesignTrueview API method does not return the actual embroidery file. You need the api/newDesign method for that.
POST parameters
| Parameter | Type | Required | Description |
| appId | String | ✅ | App ID from your Wilcom Developer Portal account. |
| appKey | String | ✅ | 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
| Component | Details |
| <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
- This method is typically used for previewing a design layout before committing to stitch data.
- The result image is transparent PNG, named using the trueview_file attribute in the recipe’s <output> section.
- If you need to generate the actual embroidery design file, use api/newDesign.
- If you only need a preview, use api/newDesignTrueview.