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

Supply Voltage (V)

Required range: x >= 0.01
ledPreset
enum<string>

LED Colour Preset

Available options:
custom,
red,
orange,
yellow,
green,
blue,
white,
uv,
ir
forwardVoltage
number

LED Forward Voltage (Vf)

Required range: x >= 0
forwardCurrent
number

LED Forward Current

Required range: x >= 0.001
currentUnit
enum<string>

Current Unit

Available options:
mA,
A
ledCount
number

Number of LEDs

Required range: 1 <= x <= 20
configuration
enum<string>

Configuration

Available options:
series,
parallel

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.