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
password
string
required

Password / passphrase

saltMode
enum<string>

Salt

Available options:
auto,
custom
customSalt
string

Custom salt

customSaltEncoding
enum<string>

Custom salt encoding

Available options:
text,
hex
algorithm
enum<string>

Hash algorithm

Available options:
sha256,
sha384,
sha512
iterations
number

Iterations

Required range: 1000 <= x <= 1000000
keyLengthBits
number

Key length (bits)

Required range: 8 <= x <= 2048
expectedKey
string

Expected key (optional)

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.