Skip to main content
POST
Textile Yarn Converter

Authorizations

Authorization
string
header
required

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

Body

application/json
ioCategory
enum<string>

What to convert

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

Size

ioNeedleSystem
enum<string>

System

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

System

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

Yarn weight

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

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

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

request_id
string
credits_remaining
integer | null

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