Generate TrueView for vector artwork
The vectorArtTrueview API method converts the vector file into an embroidery design using auto-digitizing, then produces a transparent TrueView™ preview — transparent PNG, 1:1 scale. It also provides estimated design information, including dimensions, stitch count, and more (as per api/designInfo).
This function is image-only — it does not return EMB or machine file formats. Use api/vectorArtDesign 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 vector file, digitizing options, output, and files. |
XML structure
<xml>
<vector file="logo.svg" /> <!-- Vector file instructions -->
<autodigitize_options detail_level="medium" /> <!-- Auto-digitizing settings -->
<output trueview_file="logo_preview.png" /> <!-- Output format and version -->
<files>
<file filename="logo.svg" filecontents="..." /> <!-- Vector file to process -->
</files>
</xml>
Response
On success, the API returns an XML string
containing the generated TrueView™ and estimated design information:
<xml>
<files>
<file filename="logo_preview.png" filecontents="..." /> <!-- Transparent PNG TrueView -->
</files>
<design_info height="48.3" width="65.7" stitches="1895" colors="4" /> <!-- Estimated design information -->
</xml>
XML components
| Component | Details |
| <vector> | Specifies which vector file referenced in <files> will be processed. |
| <autodigitize_options> | Optional. Controls size (width, height), DPI, threads to use for the auto-digitizing process. |
| <output> | Optional. Specifies the output preview filename. |
| <files> | Contains the input vector file and the resulting TrueView™ image. |
| <design_info> | Provides estimated design properties for the generated embroidery preview. |
Remarks
- Vector file formats supported — SVG, EPS, PDF, etc.
- TrueView™ image shows the final embroidery layout visually — great for fast previews or customer approvals.
- Estimated design info is included (like api/designInfo).
- No actual stitch/design file is returned — just the preview.
- Large or overly complex vector files might result in errors or low-quality outputs.
- For best results, optimize vector paths before submission.