Generate embroidery design for vector artwork

Generate embroidery design for vector artwork

The vectorArtDesign API method automatically digitizes vector artwork file — e.g. PDF, SVG, EPS — to produce an embroidery design file — EMB, DST, etc. Optionally, this method can also generate a transparent TrueView™ preview of the design and provide estimated design metadata — height, width, stitch count, etc — 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 vector file, digitizing options, output, and files to process. 

XML structure

<xml>
  <vector file="logo.pdf" />      <!-- Vector processing instructions -->
  <autodigitize_options detail_level="high" simplify_paths="true" />      <!-- Auto-digitizing settings -->
  <output design_file="logo.emb" trueview_file="logo.png" format="EMB" />      <!-- Output format and version -->
  <files>
    <file filename="logo.pdf" filecontents="..." />      <!-- Vector file to process -->
  </files>
</xml>

Response

On success, the API returns an XML string containing the generated design file(s) and estimated design information:

<xml>
  <files>
    <file filename="logo.emb" filecontents="..." />                                         <!-- Embroidery design -->
    <file filename="logo.png" filecontents="..." />                                         <!-- Optional TrueView -->
  </files>
  <design_info height="50" width="80" stitches="3221" colors="3" />     <!-- Estimated design information -->
</xml>

XML components

Component
Details
Specifies which vector file in <files> will be processed. 
<autodigitize_options>
Defines settings used during auto-digitizing. Controls detail, stitch complexity, etc.
<output>
Defines output format and filenames for design and preview.
<files>
Contains the input vector file and the resulting design and TrueView™ file(s). 
<design_info>
Provides estimated design properties — e.g. size, stitch count — for the generated embroidery file. 

Remarks

  1. Some complex vector artwork may not digitize well.
  2. There are specific limitations on input vector files for auto-digitizing. Refer to Auto-digitize artwork limitations for guidelines and best practices.
  3. Supported vector formats are listed in Supported formats section of this document.

    • Related Articles

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

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