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 Simulate

Format

/api/Autodigitize/Simulate?Path=*path

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

Description

Return a estimation for the design stitches and a reduced color image(embroidery like) in base64 format.

Parameters

• Path - Is the file that was uploaded to the server using Upload
• FinalWidth - Width in pixels for resizing the image before color reduction. The width also participates in stitches estimation calculation. If value is empty, physical image width is taken as default.
  • FinalWidth will take effect only if original image width is greater than height. The resizing is done proportionally.
• FinalHeight - Height in pixels for resizing the image before color reduction. The height also participates in stitches estimation calculation. If value is empty, physical image height is taken as default.
  • FinalHeight will take effect only if original image height is greater than width. The resizing is done proportionally.
• NumColors - Maximum number of colors which will be used for color reduction process. If there is no value then it will be decided by the process.
• Density - Valid values : Low, Medium, High. Desnity of stitches that participates in stitches estimation calculation. Default is "Low".
• BackgroundColor - True/False value that specifies which colour in the image - except for the trasparent - is considered to be the background. Default is false. This setting works independently of the GenerateTransparentBackground.
• BackgroundRed - 0-255 value for Red for the BackgroundColor. Value should be set when BackgroundColor is true. Default is 0.
• BackgroundGreen - 0-255 value for Green for the BackgroundColor. Value should be set when BackgroundColor is true. Default is 0.
• BackgroundBlue - 0-255 value for Blue for the BackgroundColor. Value should be set when BackgroundColor is true. Default is 0.

Example

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

Sample Output

{
"StitchesEstimation": 78642.0,
"Preview": "base64string"
}

---