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

Mode

Available options:
totp,
hotp
secret
string

Secret (Base32)

algorithm
enum<string>

Hash algorithm

Available options:
sha1,
sha256,
sha512
digits
enum<string>

Digits

Available options:
6,
7,
8
timestamp
number

Unix timestamp (seconds)

Required range: x >= 0
period
number

Period (seconds)

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

Counter

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.