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

1. Vector file formats supported — SVG, EPS, PDF, etc.
2. TrueView™ image shows the final embroidery layout visually — great for fast previews or customer approvals.
3. Estimated design info is included (like api/designInfo).
4. No actual stitch/design file is returned — just the preview.
5. Large or overly complex vector files might result in errors or low-quality outputs.
6. For best results, optimize vector paths before submission.

---

Related topics

1. Supported vector formats
   
2. Auto-digitize artwork limitations

• Related Articles

• Understanding auto-digitizing

  In the Embroidery Web API, auto-digitizing uses technology from EmbroideryStudio to convert images into embroidery designs. The process is as follows... Upload an image (bitmap or vector). The Embroidery Engine generates an EMB file (Wilcom’s native ...

• Auto-digitizing calls

  AutoDigitizing is a paid feature not included in standard API plans. It converts an image → EMB → TrueView PNG / machine file. It uses specific API calls. It is charged per call because these requests are resource-intensive. Usage can be tracked in ...

• Remove artwork background

  This note explains how the Remove Artwork Background option works in the Design Image Concept web application. Developers often expect this setting to also affect TrueView outputs from EMB files, but it only applies to artwork input images. Key ...

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