The bitmapArtDesign API method automatically digitizes a bitmap
image to produce an embroidery design file in EMB format (and/or other
supported formats). The API first removes the image’s background (as done in bitmapArtPreview) and then performs auto-digitizing. Optionally, this method can also generate a
transparent TrueView preview of the design, as well as design information such
as height, width, and stitch count (same as 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 vector file, digitizing options, output, and files to process. |
<xml>
<bitmap ... /> <!-- Bitmap processing instructions -->
<autodigitize_options ... /> <!-- Auto-digitizing settings -->
<output ... /> <!-- Output format and version -->
<files>
<file ... /> <!-- Bitmap file to process -->
</files>
</xml>
Response
On success, the API returns an XML string
containing the generated design file(s) and design information:
<xml>
<files>
<file ... /> <!-- Generated design file and optional TrueView™
image -->
</files>
<design_info ... /> <!-- Estimated design information -->
</xml>
XML components
| Component | Details |
| <bitmap> | Specifies which bitmap 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 bitmap file and the resulting TrueView™ image. |
| <design_info> | Provides estimated design properties for the generated embroidery preview. |
- 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.