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

Email format

Available options:
firstname.lastname,
f.lastname,
firstnamelastname,
firstname_lastname,
username,
random
domain
enum<string>

Domain

Available options:
random,
gmail.com,
yahoo.com,
outlook.com,
hotmail.com,
protonmail.com,
custom
customDomain
string

Custom domain

count
number

How many

Required range: 1 <= x <= 1000
exportFormat
enum<string>

Output format

Available options:
plain,
csv,
json

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.