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

Material

Available options:
mulch,
topsoil,
gravel,
sand
unitSystem
enum<string>

Unit System

Available options:
imperial,
metric
length
number

Length

Required range: x >= 0.01
width
number

Width

Required range: x >= 0.01
depth
number

Depth

Required range: x >= 0.01
wastePct
number

Waste / Overage (%)

Required range: 0 <= x <= 100
bagSize
number

Bag Size

Required range: x >= 0.01
truckCapacity
number

Truck / Trailer Capacity

Required range: x >= 0.01

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.