EWA API methods overview

EWA API methods overview

The Embroidery Web API (EWA) by Wilcom provides a powerful set of endpoints for creating, modifying, previewing, and analyzing embroidery designs through XML-based requests. These APIs support both bitmap and vector artwork as inputs and produce stitch files, preview images, and design metadata.

🔍 General info & metadata

API

Description

api/info

Returns the current version and available features of the EWA API. Useful for diagnostics or API version control.

api/designInfo

Extracts metadata from an existing embroidery file (e.g., dimensions, stitch count, color changes).

api/designTrueview

Generates a TrueView™ image (transparent, realistic preview) from an existing design file.

🛠️ Design creation & composition

API

Description

api/newDesign

Creates a new composite design using a recipe of decorations and source files. Returns the actual stitch file (.EMB) and optionally TrueView and design info.

api/newDesignTrueview

Creates only a TrueView™ image from a new design recipe — faster and lighter than generating a full design file.

✏️ Design editing

API

Description

api/editDesign

Modifies existing embroidery designs by updating lettering or monogram objects. Returns new .EMB file, optional TrueView, and design info.

api/editDesignTrueview

Like editDesign, but only returns a transparent TrueView™ image and updated design info. No actual stitch file is returned.

🔤 Lettering previews

API

Description

api/newLetteringPreview

Quickly renders a simplified, transparent bitmap preview of a single lettering or team name decoration. Returns estimated design info.

🖼️ Bitmap artwork APIs

API

Description

api/bitmapArtPreview

Converts bitmap artwork (e.g., JPG, GIF) to PNG with transparent background. Returns the cleaned-up image and basic source info.

api/bitmapArtTrueview

Auto-digitizes a bitmap image and returns a TrueView™ embroidery preview + estimated design info.

api/bitmapArtDesign

Fully digitizes a bitmap into a stitch file (EMB) and optionally returns a TrueView™ and design info.

📐 Vector artwork APIs

API

Description

api/vectorArtPreview

Converts a vector file (e.g., SVG, EPS) to a transparent PNG image. No stitching involved — just visual.

api/vectorArtTrueview

Auto-digitizes a vector into a TrueView™ preview. Returns transparent image + estimated design info.

api/vectorArtDesign

Fully digitizes a vector into a stitch file, and optionally includes TrueView™ and design info.

    • Related Articles

    • EWA API getting started

      These notes guide developers through the initial setup, authentication, API calling structure, and development tools available for integrating the Wilcom Embroidery Web API into web applications. ✅ Step 1: Sign up and get API credentials Visit the ...

    • EWA API overview

      Wilcom’s Embroidery Web API (EWA) is a modern, third-generation web-based software toolkit designed specifically for web developers in the embroidery and apparel industries. It allows businesses to seamlessly integrate professional embroidery ...

    • EWA API technical notes

      Wilcom’s Embroidery Web API is a cloud-hosted, RESTful interface that enables developers to integrate professional embroidery design and personalization features into websites, e-commerce platforms, or internal systems. The API supports rendering, ...

    • EWA API business case

      In today’s fast-paced, personalization-driven market, embroidery businesses and e-commerce platforms must offer instant customization, real-time previews, and automated production workflows. The Wilcom Embroidery Web API (EWA) is a robust, ...

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