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
keyboardType
enum<string>

Keyboard type

Available options:
compact,
laptop,
standard,
mechanical,
custom
customTravel
number

Distance per keystroke (cm)

Required range: 0.1 <= x <= 20
typingSpeed
number

Typing speed (WPM)

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

Hours spent typing per day

Required range: 0.1 <= x <= 24
daysPerWeek
number

Days typing per week

Required range: 1 <= x <= 7
years
number

Time span (years)

Required range: 0.1 <= x <= 100

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.