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
| 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 bitmap, digitizing options, output, and files to process. |
<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. |
- TrueView is a preview only. For real embroidery files, use bitmapArtDesign.
- There are specific limitations on input bitmap files for auto-digitizing. Refer to Auto-digitize artwork limitations for guidelines and best practices.
- Supported bitmap formats are listed in Supported formats section of this document.