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

Amount ($)

Required range: x >= 0.01
startYear
number
required

Start Year

Required range: 1900 <= x <= 2100
endYear
number
required

End Year

Required range: 1900 <= x <= 2100
inflationRate
number
required

Annual Inflation Rate (%)

Required range: -50 <= x <= 1000

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.