Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
garmentType
enum<string>

Garment

Available options:
skirt,
shirt,
dress,
pants,
quilt
unitSystem
enum<string>

Units

Available options:
imperial,
metric
fabricWidthImperial
enum<string>

Fabric width

Available options:
45,
54,
60
fabricWidthMetric
enum<string>

Fabric width

Available options:
115,
137,
150
bust
number

Bust / chest

Required range: x >= 1
hip
number

Hip

Required range: x >= 1
garmentLength
number

Length

Required range: x >= 1
sleeveLength
number

Sleeve length

Required range: x >= 0
blockSize
number

Finished block size

Required range: x >= 1
blockCount
number

Number of blocks

Required range: x >= 1
seamAllowance
number

Seam allowance

Required range: x >= 0
patternRepeat
number

Pattern repeat

Required range: x >= 0
safetyMargin
number

Extra buffer %

Required range: 0 <= x <= 25

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.