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

Head Over Crest (H)

weirType
enum<string>

Weir Type

Available options:
rectangular,
vnotch
dischargeCoefficient
number

Discharge Coefficient (Cd)

Required range: 0.3 <= x <= 1
crestWidth
number

Crest Width (L)

notchAngle
number

V-notch Angle (θ)

Required range: 10 <= x <= 170

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.