Embroidery formats in API calls

Embroidery formats in API calls

Most API calls in the EWA API return an embroidery file. This article explains the difference between file types and how to request or upload them.

Native vs machine formats

Native format (EMB):

Wilcom’s own design format is EMB – e.g. <design-name>.EMB. This is the format created in EmbroideryStudio.

Machine formats:

Each embroidery machine uses its own file type, such as:
Machine
File type
Tajima
DST
Happy
TAP
Melco
EXP
Barudan
U??
SWF
EBD

EMB designs can be exported to the format required by the machine.


Key differences

Native format (EMB):

  1. Object-based and editable.
  2. Stores complete design details: shapes, outlines, colors, stitch types, densities, underlays, pull compensation, trims, needle changes, etc.
  3. Contains both editable objects and generated stitches.
  4. Scalable and re-editable at any time.

Machine formats:

  1. Contains only stitch data and machine stops (usually for color changes).
  2. Not fully editable or scalable (scaling more than ±10% lowers stitch quality).
  3. Some formats support extra functions like needle numbers, trims, or speed/tension changes.

API calls – requesting file formats

When making an API call, you must specify the file format you want.
Example: request both a TrueView image and an EMB file:
Quote<output trueview_file="DesignName.png" design_file="DesignName.emb" />
To request a machine format instead:
Quote<output trueview_file="DesignName.png" design_file="DesignName.dst" /> <output trueview_file="DesignName.png" design_file="DesignName.exp" />

Uploading files in API calls

  • Some functions require an EMB file.
  • Example: editing lettering is only possible in EMB format, not in a machine file.

API example:

Quote<design file="designname.emb" colorwaytype="all" />
Info
EMB files can include multiple colorways in a single design.