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
stitchesWide
number
required

Design Width (stitches)

Required range: x >= 1
stitchesHigh
number
required

Design Height (stitches)

Required range: x >= 1
fabricCount
enum<string>

Fabric Count (threads per inch)

Available options:
11,
14,
16,
18,
20,
22,
25,
28,
32
overTwo
enum<string>

Stitching Over

Available options:
1,
2
margin
number

Margin per Side (inches)

Required range: x >= 0

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.