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.