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
projectType
enum<string>

Project

Available options:
sweater_m,
cardigan_m,
baby_blanket,
throw_blanket,
queen_blanket,
scarf,
hat_adult,
mittens,
socks_crew,
pillow_18,
dishcloth,
market_bag,
custom
customYards
number

Base yardage (yards)

yarnWeight
enum<string>

Yarn weight

Available options:
lace,
super_fine,
fine,
light,
medium,
bulky,
super_bulky,
jumbo
stitchPattern
enum<string>

Stitch pattern

Available options:
stockinette,
ribbing,
cables,
lace,
colorwork,
textured,
brioche
skeinYards
number

Yards per skein

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.