Export config

We support exporting to different file types. Each file type has specific configurations.

Reference: Create new export request

Common config

These are the basic configs that determine what the export output will look like.

Request parameters

Parameter Type Description Default
singleInstance bool true: only ONE object instance is generated.
false: number of object instances follows object's material group configuration data.
false
materialGroup bool true: apply the fabric types in object's material group configuration data.
false: use default regular fabric type.
true
singleFile bool true: Only one file is generated.
false: Multiple files are generated based on Material
true
{
  "config": {
    "singleInstance": false,
    "materialGroup": true,
    "singleFile": true
  }
}

The combinations of singleInstance and materialGroup values causes different draft generation results.

Usage

The following sections describe export requests with different file types using the same API Request:

POST https://api.bespokify.com/v2/exports

The file type is indicated by fileType argument, valid values are: dxf, plt, pdf.

DXF

There is no advanced config for dxf files.

{
  "draftId": "6fedf9a8-3604-4746-b5ab-f6d6fda922c2",
  "fileType": "dxf"
}

Fashion CAD

Request parameters

Parameter Type Description
format string The format
driver string The driver

Supported drivers for each format

format driver
aama generic, etCad, optitex
astm generic
tiip generic

Example response

{
  "draftId": "6fedf9a8-3604-4746-b5ab-f6d6fda922c2",
  "fileType": "dxf",
  "config": {
    "format": "aama",
    "driver": "generic"
  }
}

PLT

Request parameters

Parameter Type Description Default
pen string The map config the pen used for each layer. Format: LAYER PEN
The unmentioned layers have default pen is SP1
STITCH SP1 MARKUP SP1 SEAM SP2
resolution number The plotter resolution 1016
pageLength number The block width of plotter machine. Unit: centimeter 40
scale object The scale object {x: 1, y: 1}

Example response

{
  "draftId": "6fedf9a8-3604-4746-b5ab-f6d6fda922c2",
  "fileType": "plt",
  "config": {
    "pen": "STITCH SP1 MARKUP SP1 SEAM SP2",
    "resolution": 1016,
    "pageLength": 40,
    "scale": {
      "x": 1,
      "y": 1
    }
  }
}

PDF

Request parameters

Parameter Type Unit Description Default
width number cm The page width 84.1
height number cm The page height 118.9
leftMargin number cm The left margin 3
topMargin number cm The top margin 3
rightMargin number cm The right margin 3
bottomMargin number cm The bottom margin 3
glueMargin bool Use glue margin false
orientation string Possible values: Portrait,Landscape Portrait

Example response

{
  "draftId": "6fedf9a8-3604-4746-b5ab-f6d6fda922c2",
  "fileType": "pdf",
  "config": {
    "width": 84.1,
    "height": 118.9,
    "leftMargin": 3,
    "topMargin": 3,
    "rightMargin": 3,
    "bottomMargin": 3,
    "glueMargin": false,
    "orientation": "Portrait"
  }
}