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
batteryCapacity
number

Battery Capacity (kWh)

Required range: 1 <= x <= 300
startPercent
number

Start Charge (%)

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

Target Charge (%)

Required range: 0 <= x <= 100
ratePreset
enum<string>

Rate Preset

Available options:
custom,
0.16,
0.34,
0.25,
0.30,
0.13,
0.10
homeRate
number

Home Rate ($/kWh)

Required range: x >= 0.001
publicRate
number

Public Rate ($/kWh)

Required range: x >= 0
efficiency
number

Vehicle Efficiency

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

Distance Unit

Available options:
km,
mi
dailyDistance
number

Avg Daily Distance

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.