This designTrueview API method retrieves design information and
TrueView™ images – PNG with transparent background – for the current, all, or
specific colorways in the design. This API also returns design metadata,
including dimensions (height, width), stitch count, and other details.
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>
<design ... /> <!-- Optional: specifies which colorway(s) to render -->
<trueview_options ... /> <!-- Optional: render settings like DPI -->
<recolor ... /> <!-- Optional: recoloring for colorway -->
<files>
<file filename="design1.emb" filecontents="..." />
</files>
</xml>
Response
Returns metadata and one or more TrueView PNG files:
<xml>
<design_info>...</design_info> <!-- Design metadata -->
<files>
<file filename="Default.png" filecontents="..." />
<file filename="BlueOnWhite.png" filecontents="..." />
<!-- One file per colorway -->
</files>
</xml>
XML components
| Component | Details |
| <design> | Optional. Design is specified in the <design> block via a design_file. By default, colorwaytype is set to current. |
| <trueview_options> | Optional. It can include output settings, such as DPI for the TrueView image. |
| <recolor> | Optional. Allows you to override the design’s colorway. |
| <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 updated details about the modified design — e.g. size, stitch count. |
- TrueView images are 1:1 scale PNGs with transparency.
- If multiple colorways exist and
colorwaytype is current, the output file name defaults to Default.png.
Otherwise, filenames will match the colorway name plus file extension. (Note:
This default filename issue will be resolved soon.)
- Supported bitmap formats are listed in Supported formats section of this document.
Related Articles
View design information
The Design Information pane displays detailed information about a selected design in the Library. From this pane you can review metadata, inspect technical design properties, view available colorways, and manage attachments associated with the ...
Update design information
The update design information feature allows you to modify the metadata associated with a design in Wilcom Library. Keeping design information up to date ensures designs are easy to find, correctly categorized, and ready for production workflows. ...
Upload design files
Uploading files to Wilcom Library allows you to store embroidery designs and related materials in a central location where they can be accessed and shared across your organization. When a design file is uploaded, Library creates a design record that ...
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 ...
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 ...