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

What to convert

Available options:
knitting-needle,
crochet-hook,
yarn-weight
value
string

Size

needleSystem
enum<string>

System

Available options:
metric,
us,
uk,
japanese
crochetSystem
enum<string>

System

Available options:
metric,
us-letter,
uk,
japanese
yarnLookup
enum<string>

Yarn weight

Available options:
0,
1,
2,
3,
4,
5,
6,
7

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.