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

Country

Available options:
random,
AD,
AE,
AL,
AT,
AZ,
BA,
BE,
BG,
BH,
BR,
BY,
CH,
CR,
CY,
CZ,
DE,
DK,
DO,
EE,
EG,
ES,
FI,
FO,
FR,
GB,
GE,
GI,
GL,
GR,
GT,
HR,
HU,
IE,
IL,
IQ,
IS,
IT,
JO,
KW,
KZ,
LB,
LC,
LI,
LT,
LU,
LV,
LY,
MC,
MD,
ME,
MK,
MR,
MT,
MU,
NL,
NO,
PK,
PL,
PS,
PT,
QA,
RO,
RS,
SA,
SC,
SD,
SE,
SI,
SK,
SM,
ST,
SV,
TL,
TN,
TR,
UA,
VA,
VG,
XK
count
number

How many

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

Format

Available options:
spaced,
compact
seed
string

Seed (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.