Generate embroidery design for bitmap artwork
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.
Related Articles
Capture design bitmap
The Capture Design Bitmap feature allows you to create and download a bitmap image of a design stored in Wilcom Library. Bitmap previews are useful for sharing design visuals with customers, including designs in documentation, or referencing designs ...
How to resize an embroidery design
To resize an embroidery design in WilcomWorkspace: Log into WilcomWorkspace. Browse to TrueSizer from the left-side menu 3. Open your embroidery design 4. In the right-side Edit panel, change the Width or Height of the design and press Enter the ...
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 ...
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 ...
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 ...