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>

Type

Available options:
text,
phone,
email,
wifi
text
string

Message

phone
string

Phone number

email
string

Email address

emailSubject
string

Subject

emailCc
string

CC

emailBcc
string

BCC

emailBody
string

Message body

wifiSsid
string

Network name (SSID)

wifiPassword
string

Password

wifiSecurity
enum<string>

Security

Available options:
WPA,
WEP,
nopass
ecLevel
enum<string>

Error correction

Available options:
L,
M,
Q,
H
margin
number

Space around

Required range: 0 <= x <= 20
dotSize
number

Dot size

Required range: 1 <= x <= 20
background
string

Background

color
string

QR colour

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.