The newDesign API method creates a new embroidery design file from a recipe and returns the actual stitch data in EMB format and/or other supported formats.
Optionally, it can also generate a transparent TrueView™ preview (transparent PNG) as well as design metadata — dimensions, stitches, colors.
POST parameters
| Parameter | Type | Required | Description |
| appId | String | ✅ | App ID from your Wilcom Developer Portal account. |
| appKey | String | ✅ | App Key from your Wilcom Developer Portal account. |
requestXml | String | ✅
| An XML string specifying the full design recipe and its component files. |
<recipe>...</recipe> <!-- Required: Design components and output settings -->
<files>
<file filename="Block1.abc" filecontents="..." />
<file filename="threadchart.tch" filecontents="..." />
</files>
</xml>
Response
On success, the API returns
an XML string containing the generated embroidery design file, and optionally
the TrueView™ image and design metadata:
<xml>
<files>
<file filename="output.emb" filecontents="..." /> <!-- Main EMB design -->
<file filename="preview.png" filecontents="..." /> <!-- Optional TrueView™ preview -->
</files>
<design_info>...</design_info> <!-- Design metadata -->
</xml>
XML components
| Component | Details |
| <recipe> | The design is based on the full <recipe> definition. This is the root container for describing a complete embroidery design or preview. |
| <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. |
The output.emb is named based on the design_file attribute in the recipe’s <output> block.
- If trueview_file is specified in the recipe, a TrueView PNG will also be included in the response.
- If you only need a preview, use api/newDesignTrueview.
- To inspect existing design files, use api/designInfo.
- Supported bitmap formats are listed in Supported formats section of this document.