Generate preview image for vector artwork

Generate preview image for vector artwork

The vectorArtPreview API method converts a vector file — e.g. PDF, SVG, etc — to a transparent PNG image with a transparent background. The resulting image’s transparent edges are trimmed automatically. Optionally, you can specify DPI for resolution quality. The default is generated at 96 DPI.

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 to process.

XML structure

<xml>
  <vector file="logo.pdf" dpi="150" remove_background="true" />   <!-- Vector processing instructions -->
  <files>
    <file filename="logo.pdf" filecontents="..." />        <!-- Vector file to process -->
  </files>
</xml>

Response

On success, the API returns an XML string containing the processed PNG image:
<xml>
  <files>
    <file filename="logo.png" filecontents="..." />  <!-- Transparent PNG result -->
  </files>
</xml>

XML components

ComponentDetails
<vector>Specifies which vector file in <files> will be processed. 
<files>Contains the input vector file and the resulting design and TrueView file(s). 

Remarks

Remark
Details
File support
Accepts standard vector formats like PDF, SVG, EPS. 
DPI (resolution)
Optional. Accepts values from 1–480 (default is 96 DPI).
Background removal
Automatically removes white/solid backgrounds. Controlled by remove_background attribute (default: true).
Transparent edge trimming
PNG output has cropped edges to remove whitespace.

    • Related Articles

    • Protecting against unsuitable image uploads

      Auto-digitizing (automatic digitizing) converts artwork into embroidery files. The Embroidery Web API uses AI to reduce colors, define objects, and choose stitch types and directions, similar to what a human digitizer would do. ⚠️ Not all images are ...

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

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

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

    • Preview designs

      The Preview Design feature allows you to view a visual representation of an embroidery design directly within Wilcom Library. Previewing a design helps you quickly inspect the design layout, colors, and overall appearance without downloading or ...