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

Flow depth

Required range: x >= 0
manningN
number
required

Manning's roughness coefficient (n)

Required range: x >= 0
channelSlope
number
required

Channel bed slope

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

Unit system

Available options:
si,
us
channelShape
enum<string>

Channel shape

Available options:
rectangular,
trapezoidal,
triangular
bottomWidth
number

Bottom width

Required range: x >= 0
sideSlope
number

Side slope (z, horizontal:vertical)

Required range: x >= 0

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.