Generate TrueView for bitmap artwork

Generate TrueView for bitmap artwork

This bitmapArtTrueview API method automatically digitizes a bitmap image and generates a transparent TrueView. This API takes a bitmap image, removes its background, then auto-digitizes it to generate a TrueView embroidery simulation image (transparent PNG). It also provides estimated design information such as height, width, and stitch count (similar to api/designInfo).

POST parameters

ParameterTypeRequiredDescription
appIdString✅App ID from your Wilcom Developer Portal account.
appKeyString✅App Key from your Wilcom Developer Portal account.
requestXml
String
✅
An XML string specifying the bitmap, digitizing options, output, and files to process.

XML structure

<xml>
  <bitmap file="logo.png" />                                              <!-- Specifies bitmap image -->
  <autodigitize_options width="100" height="100" />   <!-- Optional: controls sizing, threads -->
  <output format="PNG" />                                              <!-- Optional: output format/version -->
  <files>
    <file filename="logo.png" filecontents="..." />           <!-- Bitmap 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="auto_logo.png" filecontents="..." />  <!-- TrueView image -->
  </files>
  <design_info width="100" height="98" stitches="4500" ... />  <!-- Design stats -->
</xml>

XML components

Component
Details
Specifies which bitmap file referenced in <files> will be processed.
Optional. Controls size (width, height), DPI, threads to use for the auto-digitizing process.
Optional. Specifies the output preview filename.
Contains the input bitmap file and the resulting TrueView™ image. 
Provides estimated design properties for the generated embroidery preview. 

Remarks

  1. TrueView is a preview only. For real embroidery files, use bitmapArtDesign.
  2. There are specific limitations on input bitmap files for auto-digitizing. Refer to Auto-digitize artwork limitations for guidelines and best practices.
  3. Supported bitmap formats are listed in Supported formats section of this document.

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