QR Codes

Encode content as a QR code

Stateless QR encoder for seven content types: url, text, wifi, vcard, email, phone and sms. Nothing is stored or tracked.

Auth: API key (Bearer flyn_sk_live_...) or an MCP OAuth access token (Bearer flyn_mcp_at_...). The dashboard session cookie is not accepted.

Plan: url, text and wifi with PNG and the default colours on every plan. vcard, email, phone, sms, SVG and custom colours need Pro, Lifetime or Team (a member of a paying owner's workspace has the effective plan team); Free gets 403 UPGRADE_REQUIRED.

Rate limit: 60 requests per 60 s per client IP, fixed window, in memory per server instance, checked before authentication.

post/api/qr

Request

  • Base URL: https://www.flyn.to
  • URL: https://www.flyn.to/api/qr
  • Auth: HTTP bearer

Request body

type'url' | 'text' | 'wifi' | 'vcard' | 'email' | 'phone' | 'sms'

Content type. vcard, email, phone and sms are Pro (checked before field validation).

urlstring

Required for type url. Trimmed and encoded as sent: no URL validation, no safety scan, no scan marker.

textstring

Required for type text. Not trimmed; whitespace only fails with "Nothing to encode.".

wifiSsidstring

Required for type wifi.

wifiPassstring

Wi-Fi password; left out when wifiEnc is nopass.

wifiEnc'WPA' | 'WEP' | 'nopass'

WPA3 networks use WPA.

wifiHiddenboolean

Only literal true marks the network hidden.

vcNamestring

Required for type vcard.

vcOrgstring
vcPhonestring

A number without a leading + adds a warning.

vcEmailstring
vcUrlstring
emailstring

Required for type email.

emailSubjectstring
emailBodystring
phonestring

Required for type phone. Characters other than digits and + are stripped; no leading + adds a warning.

smsPhonestring

Required for type sms. Characters other than digits and + are stripped.

smsBodystring
format'png' | 'svg'

Case-sensitive. svg is Pro.

level'L' | 'M' | 'Q' | 'H'

Error correction; upper-cased first.

fgstring

Foreground colour. Anything but the default is Pro; equal to bg is 400.

bgstring

Background colour. Anything but the default is Pro.

Response

The rendered QR code.

type'url' | 'text' | 'wifi' | 'vcard' | 'email' | 'phone' | 'sms' required
labelstring required

Short human label for the content.

payloadstring required

The exact string encoded in the QR code.

qrDataUrlstring required
svgstring

Present only when format=svg.

warningsstring[]

Present when a phone, sms or vcard number has no leading +.

Changes

No recorded changes to this operation across all 1 revision of this API.