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

Solve from

Available options:
length_width,
area_length,
area_width,
perimeter_length,
perimeter_width,
diagonal_length,
diagonal_width,
area_perimeter
length
number

Length

Required range: x >= 0
width
number

Width

Required range: x >= 0
area
number

Area

Required range: x >= 0
perimeter
number

Perimeter

Required range: x >= 0
diagonal
number

Diagonal

Required range: x >= 0
unit
enum<string>

Unit

Available options:
none,
mm,
cm,
m,
km,
in,
ft,
yd,
mi
precision
enum<string>

Decimal precision

Available options:
0,
1,
2,
3,
4,
5,
6,
8,
10

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.