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

Map distance

mode
enum<string>

Find

Available options:
ratio,
distance
mapUnit
enum<string>

Map distance unit

Available options:
mm,
cm,
in
groundDistance
number

Ground distance

groundUnit
enum<string>

Ground distance unit

Available options:
m,
km,
ft,
mi
scaleDenominator
number

Scale denominator (N in 1:N)

outputGroundUnit
enum<string>

Show ground distance in

Available options:
m,
km,
ft,
mi

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.