Utilities

Generate a QR code PNG

Encodes content (with optional preset shaping for url, wifi, vcard, mailto, sms) into a PNG QR code. Returns base64 inline by default; pass save_path (absolute) to write to disk. Configurable size, foreground/background color, and Reed-Solomon correction level (L/M/Q/H).

post/v1/qr/generate

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/qr/generate
  • Auth: HTTP bearer

Request body

contentstring required

Text to encode (or preset-shaped payload — see preset).

preset'plain' | 'url' | 'wifi' | 'vcard' | 'mailto' | 'sms'

Content shaping preset. Default plain.

size_pxinteger

Output PNG side length in pixels. Default and max are service-defined.

correction_level'L' | 'M' | 'Q' | 'H'

Reed-Solomon error correction level. Default M.

foreground_colorstring

Hex color (e.g. #000000). Default #000000.

background_colorstring

Hex color (e.g. #FFFFFF). Default #FFFFFF.

save_pathstring

Absolute file path to write PNG. If omitted, returns base64.

Response

Generated PNG (base64 or saved path)

widthinteger required
heightinteger required
bytesinteger required
base64string

Base64-encoded PNG (omitted when path is set)

pathstring

Absolute path written to disk (omitted when base64 is set)

Changes

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