Retrieve design metadata

Retrieve design metadata

The designInfo API method retrieves detailed information about a design file, including dimensions (height, width), stitch count, and other metadata.


POST parameters

ParameterTypeRequiredDescription
appIdStringApp ID from your Wilcom Developer Portal account.
appKeyStringApp Key from your Wilcom Developer Portal account.
requestXml
String
An XML payload containing a single design file (as <file> inside <files>).


XML structure

<xml> 
  <files> 
    <file 
      filename="design1.emb" 
      filecontents="..." 
    />
  </files> 
</xml>


Response

On success, the API returns an XML string containing the design metadata:
<xml> 
  <design_info>...</design_info>   <!-- See: [design_info XML Format](#) -->
</xml>

XML components

ComponentDetails
<files>This element is used to pass one or more files to or from API endpoints. It 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. Only one design file should be included per request.
  2. Use this endpoint to inspect design characteristics before rendering, editing, or converting.
  3. Supported bitmap formats are listed in Supported formats section of this document.