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

Size to convert

mode
enum<string>

Direction

Available options:
toModel,
toReal,
scaleToScale
valueUnit
enum<string>

Unit

Available options:
mm,
cm,
m,
in,
ft,
yd
scale
enum<string>

Scale

Available options:
12,
16,
18,
20,
24,
25,
32,
35,
43,
48,
64,
72,
76,
87,
96,
144,
160,
192,
220,
285,
700,
custom
customScaleN
number

Custom scale (N in 1:N)

fromScale
enum<string>

Convert from scale

Available options:
12,
16,
18,
20,
24,
25,
32,
35,
43,
48,
64,
72,
76,
87,
96,
144,
160,
192,
220,
285,
700,
custom
fromCustomScaleN
number

Custom "from" scale (N in 1:N)

toScale
enum<string>

Convert to scale

Available options:
12,
16,
18,
20,
24,
25,
32,
35,
43,
48,
64,
72,
76,
87,
96,
144,
160,
192,
220,
285,
700,
custom
toCustomScaleN
number

Custom "to" scale (N in 1:N)

outputUnit
enum<string>

Show result in

Available options:
mm,
cm,
m,
in,
ft,
yd

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.