Skip to main content
POST
Username Generator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioBaseWord
string
required

Base Word / Keyword

ioPlatform
enum<string>

Platform

Available options:
any,
twitter,
instagram,
tiktok,
reddit,
discord,
gaming,
twitch,
github,
youtube
ioStyle
enum<string>

Style

Available options:
all,
cool,
funny,
professional,
aesthetic,
leet,
dark,
cute,
retro,
minimal,
random
ioIncludeNumbers
boolean

Include numbers

ioIncludeSeparators
boolean

Include underscores / dots

ioMaxLength
number

Max length

Required range: 3 <= x <= 39

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.