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.