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

Substrate depth

Required range: x >= 0.1
tankShape
enum<string>

Tank shape

Available options:
rectangular,
cylindrical
unit
enum<string>

Dimension unit

Available options:
in,
cm
length
number

Length

Required range: x >= 0.1
width
number

Width

Required range: x >= 0.1
diameter
number

Diameter

Required range: x >= 0.1
substrateType
enum<string>

Substrate type

Available options:
gravel,
sand,
soil,
coral,
fluorite,
custom
customDensity
number

Custom density (lb/ft³)

Required range: x >= 1

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.