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 Documentation

Description

You can create embroidery from vector or bitmap images

Format

/api/Autodigitize/Render?[path]&[parameters]

For example: /api/Autodigitize/Render?Path=MySubdirectory/MyImage.PNG

• Supporting Formats
  • Bitmap images(*.bmp;*.jpg;*.tif;*.pcx;*.mac;*.pcd;*.tga)
  • Vector images(*.cdr;*.cmx;*.emf;*.wmf;*.eps;*.ai)
  • Adobe Illustrator (AI)(*.ai)
  • Postscript (EPS)(*.eps)
  • Windows Metafiles (EMF,WMF)(*.emf;*.wmf)
  • Windows Bitmaps (BMP)(*.bmp)
  • JPEG Images (JPG)(*.jpg)
  • PNG Images(*.png)
  • TIF Images (TIF)(*.tif)
  • PCX Images (PCX)(*.pcx)
  • MAC Images (MAC)(*.mac)
  • PhotoCD (PCD)(*.pcd)
  • TARGA (TGA)(*.tga)

Working with Files

• Actions
  • Render
  • Generate
  • GetInfo
  • GenerateAll
  • Simulate
  • RenderAll

Parameters

• Autodigitize Note: The image must be uploaded using the Upload action of the API
• GenerateBackground - True/False value whether or not to generate the background of the embroidery as stitches. Default is false.
• StitchInnerBackground - True/False value whether or not to stitch the inner areas of the background. Default is false.
• IgnoreSmallAreas - True/False value whether or not to ignore the small areas of background. Default is false.
• UseImageDimensions - True/False value whether or not to include the image size in the size of the final image. Default is false.
• CreateSatinAndSteil - True/False value whether or not to create satin and steil segments. If False, complex fill segments will be created instead. Default is true.
• CenterResult - True/False value whether or not to center the result around (0,0). If False, the result will have the top left corner at (0,0). Default is false.
• AddSteilBorders - True/False value whether or not to add steil borders to large complex fill segments. Default is false.
• ThreadThickness - Thickness of the thread. The default value is 5mm.
• The supported values are between 1mm to 99mm
• ThreadType - Type of the thread. The value default is ttMetallic.
• ttMetallic
• ttRayon
• ttCotton
• ttNylon
• ttPolyester
• MatchThreadChart - Name of a thread chart that should be used to color match threads for the final design. If empty, RGB values that match the image colors will be used.
• BackgroundColor - True/False value that specifies which colour in the image is considered to be the background when deciding whether or not to stitch it. Default is false.
• BackgroundColor Note: If true and the following values aren't not specified than the max value for RGB will be assumed being 255.
• BackgroundColor Note: Requires GenerateBackground set to True.
• BackgroundRed - 0-255 value for Red for the BackgroundColor. Default is 255 if BackgroundColor is True.
• BackgroundGreen - 0-255 value for Green for the BackgroundColor. Default is 255 if BackgroundColor is True.
• BackgroundBlue - 0-255 value for Blue for the BackgroundColor. Default is 255 if BackgroundColor is True.
• MaximumRunWidth - Value in embroidery points to override the default outlined below
• MaximumSatinWidth - Value in embroidery points to override the default outlined below
• MaximumSteilWidth - Value in embroidery points to override the default outlined below
• By default, segments will be digitized as follows:
• Width Segment type applied
• 1–5 points Run Stitch
• 6–15 points Steil Stitch
• 15–70 points Satin Column
• 70 points or wider Complex fill
• Overrides for segement widths based on type
• NumColors - Is the number of colours in the palette
• The original colors of the image (RGB) will be used and closely matched to a palette
• Setting the value of NumColors to a value less than the original number will automatically attempt to select the best color for each reduced thread
• Setting the value of NumColors to a value more than the original number will cause an exception
• SequenceType - Adjust the sewing sequence. Valid values are:
  • stNone
  • stMinimizeColorChanges
  • stMinimizeJumps
  • stSmart
  • Smart sequencing is a option that preferentially moves narrow border stitches later in the sewing sequence, so that the sew on top of large complex fill areas, rather than the other way around.
  • Default is stMinimizeColorChanges
• TrimType - Adjust the trim settings. Valid values are:
  • ttNever
  • ttAlways
  • ttTrimAt
  • The system will place a trim if the distance between stitches is longer than the distance displayed in the Trim At box.
  • Default is ttAlways
• LockType - Adjust the lock stitch settings. Valid values are:
  • This stitch is formed by three or four consecutive stitches of at least a 10 point movement. It should be used at the end of all columns, fills and any element where a trim will follow, such as color changes or the end of a design.
  • ltNever
  • ltAlways
  • ltAroundTrim
  • Default is ltAroundTrim
• TrimThreshold - Distance between segments to perform a trim.
• Default is 2.5mm
• FinalWidth - Width in embroidery points for resizing the image before autodigitizing.
• FinalHeight - Height in embroidery points for resizing the image before autodigitizing.
• ProportionalResize - True/False value whether or not to resize the image proportionally.
• Default is True.
• If False, the width and height will be changed independently, according to the FinalWidth and FinalHeight parameters.
• If True, the image will be resized proportionally, fitting both the FinalWidth and FinalHeight parameters.
• TimeoutSeconds - The maximum time, in seconds, to wait for the autodigitizing process.
• The default is 60 seconds.

---