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

minLength
number

Minimum length

Required range: 1 <= x <= 64
maxLength
number

Maximum length

Required range: 0 <= x <= 128
requireUppercase
boolean

Require an uppercase letter (A-Z)

requireLowercase
boolean

Require a lowercase letter (a-z)

requireDigit
boolean

Require a digit (0-9)

requireSymbol
boolean

Require a symbol (e.g. !@#$%^&*)

disallowWhitespace
boolean

Disallow whitespace

forbiddenText
string

Must not contain (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.