Parameters for all requests

• companyid - The companyid is a unique code that is given as part of your subscription to access the API. This code must be supplied as part of the header for each API request.

Refer to the Documentation page for each specific request and the supported Parameters

Autodigitize Generate

Format

/api/Autodigitize/Generate/Path=*path

*path is the file that was uploaded to the server using Upload

Description

Generates a design component and returns the production file.

Parameters

• FileName - name of the downloaded generated file. Default is the uploaded file name without the file extension. PulseLogoVerticalHQ.PNG becomes PulseLogoVerticalHQ.
• Format - Format of the returned production file. Valid values are:
  • PXF
  • DST
  • TCF
  • PES
  • Z00
  • PCF
  Default is "PXF".
• Recipe - Recipe to use when generating the final design which will apply a recipe on top of any existing. Default is "Normal". See list of available recipes.
• Reflect - The ability to mirror a design with additional options on where the mirror will occur. Valid values are:
  • rtRight
  • rtCenterX
  • rtLeft
  • rtTop
  • rtCenterY
  • rtBottom
  Default is no reflect.
• SewingMessageBefore - Message to display on machine screen before sewing begins.
• SewingMessageAfter - Message to display on machine screen after sewing completes.
• MaximumRpm - The maximum allowed value the rpm can be set to on the machine for the design.
• DesignStartPosition - When sending a stitch file to a machine you can specify where the frame will move offset from the center of the design. Parameters are:
  • X
  • Y
  Only supported for "TCF and "TBF" files.

Example

/api/Autodigitize/Generate?Path=PulseLogoVerticalHQ.PNG

PXF file of the image PulseLogoVerticalHQ.PNG.

---