Generate a QR code (manual)
qr_generateGenerate fully branded QR codes with explicit control over colors, shapes, logos, captions, and output formats when the design is already known.
Instructions
Generate a fully branded QR code with explicit control over colors, module/finder shapes, logo, caption, and output format. Use this when the user already knows the design they want.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Optional caption rendered below the QR (e.g. a slogan). | |
| content | Yes | The text or URL the QR will encode. Required. | |
| logoUrl | No | Public HTTPS URL of a logo image to embed at the center. | |
| eccLevel | No | Error-correction level (L=7%, M=15%, Q=25%, H=30%). Higher levels survive more damage but are denser. | |
| frameText | No | Label inside the frame, max 40 characters, any language (e.g. "Scan me", "View the menu"). Defaults to "Scan me". | |
| fileFormat | No | Output format. Defaults to "png". | |
| frameColor | No | Frame colour in hex, also the label background. Defaults to "#000000". | |
| frameStyle | No | Call-to-action frame around the whole QR with a short label. Never covers the QR or its quiet zone. | |
| moduleShape | No | Shape of the small modules in the QR matrix. | |
| outputWidth | No | Output width in pixels (raster) or viewport units (svg). 64-4096. | |
| outputHeight | No | Output height in pixels (raster) or viewport units (svg). 64-4096. | |
| primaryColor | No | Foreground/module color in hex (e.g. "#000000" or "#0a84ff"). | |
| frameTextColor | No | Frame label colour in hex. Defaults to "#FFFFFF". | |
| backgroundColor | No | Background color in hex (e.g. "#ffffff"). Use "transparent" for no background. | |
| additionalConfig | No | Escape hatch: any other QrConfig field the engine accepts (gradient stops, dot rotation, etc.). Merged on top of the structured fields above. | |
| finderInnerShape | No | Shape of the inner dot of the three corner finder patterns. | |
| finderOuterShape | No | Shape of the outer ring of the three corner finder patterns. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | Yes | File format the engine rendered: png, svg, jpg, webp or pdf. | |
| content | No | The text or URL the QR encodes, when the call set it. | |
| filePath | No | PDF in the stdio package only: local temp file the PDF was written to. | |
| mimeType | No | MIME type of the rendered file (the engine's contentType). | |
| sizeBytes | No | Size of the rendered file in bytes, as reported by the engine. | |
| resourceUri | No | PDF on the remote server only: URI of the embedded resource block that carries the file. |