Render QR Code

Render a QR code from a content string, plus a preset and a few colors if you want them. The content is encoded exactly as given, and the image itself is the response body. Colors too close in contrast to scan reliably are nudged apart, always: POST /v1/qr can switch that off with fixContrast, this route cannot. For a full design — palettes, gradients, logos, halos — use POST /v1/qr.

Options

Content

The value encoded into the QR code, verbatim — usually a URL, but any string works, including payload formats such as WIFI:T:WPA;S:Cafe;P:secret;;, mailto:… or a vCard. The API does not assemble those formats for you. The 4,096-character cap is a safety bound, not the real ceiling: a QR code holds roughly 2,300 bytes at most, and content past what the encoder can fit comes back as a 422 rather than an image.

Format

Output format. This alone selects the response media type — the Accept header is not consulted.

Preset

A built-in design preset, which brings the module and finder styles along with its own colors. Every preset is shown, by name, in the QR Designer — the enum here lists the IDs but not what they look like. background and margin always override it. moduleColor fully repaints the pattern only for presets that draw their modules in a single color. Most carry a multi-color palette, which takes precedence, and then moduleColor changes part of the design or nothing at all — recolor one of those with modulePalette on POST /v1/qr instead.

Size

Image width and height in pixels. Defaults to 300 for SVG and 1,024 for PNG.

Margin

Quiet zone around the QR code, in modules. One module is the minimum, so 0 and 1 both render a single-module zone.

Module Color

Module (foreground) color, as #rgb, #rrggbb or #rrggbbaa. A preset sets its own — see preset for when this overrides it. For a gradient or a multi-color palette, use POST /v1/qr.

Background

Background color, as #rgb, #rrggbb or #rrggbbaa, or transparent to leave it unpainted. A preset sets its own, which this overrides.

Response Type

Specify the response type. With Auto-detect – the default – the type is taken from the response itself, which is the appropriate choice whenever the API determines the type based on the request parameters; note that in this case the structure of the output table is only known once the node was executed. The following response types are available:

• image/svg+xml – SVG markup, UTF-8. Returned for format=svg, the default. Square, sized by size, and self-contained — a logo travels inside it as data, never as a link.
• image/png – PNG bytes, rasterized from the same SVG at size pixels square. Returned for format=png.

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code
• x-ratelimit-limit: Requests allowed in the current window.
• x-ratelimit-remaining: Requests still allowed in the current window.
• x-ratelimit-reset: Seconds until the window resets and x-ratelimit-remaining returns to x-ratelimit-limit.

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers