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
count
number

Number of Emails

Required range: 1 <= x <= 100
usernameStyle
enum<string>

Username Style

Available options:
realistic,
random
emailFormat
enum<string>

Name Format

Available options:
first.last,
firstlast,
first_last,
f.last,
flast
domainType
enum<string>

Domain Type

Available options:
common,
fictional,
custom
customDomain
string

Custom Domain

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.