QR Branding QR Branding
Enterprise-Grade QR Engine

Create Stunning QR Codes
with Pixel-Perfect Control

The most powerful QR code generation API. Design branded, artistic QR codes with custom shapes, gradients, logos, frames, and text overlays. Export in 4K resolution.

37+
Module Shapes
5
Output Formats
4K
Max Resolution
118
Templates

✨ Key Features

🎨
25+ Module Shapes
Square, Circle, Diamond, Star, Heart, Hexagon, Leaf, Mosaic, Pointed, Japanese, Shield, Arrow, Drop, and more. Plus 20+ finder patterns.
👁️
Granular Eye Control
Customize each of the 3 finder patterns independently with different shapes and colors.
🌈
Advanced Gradients
Linear, diagonal, and radial color transitions. Apply to modules, eyes, or both.
🖼️
Smart Frames
Auto-padded decorative frames with rounded corners and multiple styles.
✂️
Center Text Strip
Split the QR with horizontal or vertical text bands. Perfect for branding.
🏷️
Logo Integration
Upload via URL, Base64, or binary file. Auto-clears QR modules behind logo.
📐
5 Output Formats
Export as PNG, JPG, WEBP, SVG, or PDF. Up to 4K resolution. Vector & print-ready.
🔧
Helper Endpoints
Generate WiFi, vCard, and Geo strings instantly for common use cases.

🎯 Use Cases

🛍️
Product Packaging
🎫
Event Tickets
🍽️
Restaurant Menus
💼
Business Cards
📱
App Downloads
📍
Location Sharing

🚀 Quick Start

Generate your first branded QR code in seconds. Copy the example below:

⚡ Minimal Example
cURL 
curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
                    "content": "https://mywebsite.com",
                    "moduleShape": "circle",
                    "primaryColor": "#6366f1"
  }'
💡
Pro Tip: Only the content field is required. All other parameters have sensible defaults. Start simple and add customizations as needed.

🔐 Authentication

This API is accessed through RapidAPI. All authentication is handled automatically by RapidAPI when you subscribe to the API.

RapidAPI Headers (added automatically)
X-RapidAPI-Key: YOUR_RAPIDAPI_KEY
X-RapidAPI-Host: qr-branding-api.p.rapidapi.com
🚀
Getting Started: Subscribe to the API on RapidAPI and use the provided code snippets. RapidAPI handles authentication automatically.
⚠️
Security: Never expose your RapidAPI key in client-side code. Always call the API from your backend server.

Generate Custom QR

POST /api/qr/generate

The primary endpoint. Send a JSON configuration object to generate a fully customized QR code image. Returns a Base64-encoded image.

Complete Example Request

This example showcases all available customization options:

Request Body - Full FeaturedJSON
{
                // === REQUIRED ===
                "content": "https://mybrand.com",
  
                // === OUTPUT SETTINGS ===
                "eccLevel": "H",
                "pixelsPerModule": 20,
                "quietZone": true,
                "outputWidth": 1024,
                "outputHeight": 1024,
                "fileFormat": "png",
                "responseType": "base64",
  
                // === QR SHAPE (MASK) ===
                "qrShape": "circle",
                "qrShapeRadius": 0,
  
                // === COLORS & GRADIENTS ===
                "primaryColor": "#6366f1",
                "secondaryColor": "#ec4899",
                "foregroundStyle": "linearGradient",
                "gradientType": "linear",
                "gradientDirection": "diagonal",
                "gradientAngle": 45,
                "gradientColors": ["#FF0000", "#00FF00", "#0000FF"],
                "gradientOnEyes": false,
                "backgroundColor": "#ffffff",
                "transparentBackground": false,
  
                // === MODULE SHAPES & PATTERNS ===
                "moduleShape": "circle",
                "moduleScale": 0.85,
                "moduleRotation": 0,
                "moduleStyle": "solid",
                "moduleOutlineWidth": 2,
                "modulePattern": "standard",
                "moduleSizeVariation": 0,
  
                // === FINDER PATTERNS (EYES) ===
                "finderOuterShape": "circle",
                "finderInnerShape": "circle",
                "finderOuterColor": "#6366f1",
                "finderInnerColor": "#ec4899",
                "finderBorderRadius": 10,
                "finderInnerScale": 0.43,
                "finderStyle": "concentric-circles",
                "finderConcentricRings": 3,
                "finderInnerPattern": "none",
  
                // Individual Eye Overrides
                "eye1": { 
                "outerShape": "circle", 
                "innerShape": "circle",
                "outerColor": "#6366f1",
                "innerColor": "#ec4899",
                "rotation": 0
  },
                "eye2": null,
                "eye3": null,
  
                // === FRAME ===
                "frame": {
                "enabled": true,
                "shape": "speechbubble",
                "color": "#1e3a5f",
                "secondaryColor": "#4cc9f0",
                "gradientType": "linear",
                "fillColor": "#f8fafc",
                "width": 8,
                "cornerRadius": 25,
                "style": "solid",
                "padding": 20,
                "speechBubbleDirection": "bottom",
                "speechBubbleSize": 20
  },
  
                // === LOGO ===
                "logoUrl": "https://example.com/logo.png",
                "logoShape": "circle",
                "logoBorderWidth": 3,
                "logoBorderColor": "#ffffff",
                "cleanBehindLogo": true,
                "logoSizePercent": 18,
                "logoPadding": 5,
                "logoShadow": true,
                "logoBackground": "solid",
                "logoBackgroundColor": "#ffffff",
  
                // === VISUAL EFFECTS ===
                "effects": {
                "shadow": true,
                "shadowColor": "#00000040",
                "shadowOffsetX": 5,
                "shadowOffsetY": 5,
                "shadowBlur": 10,
                "glow": false,
                "glowColor": "#00FF00",
                "glowIntensity": 10,
                "glowRadius": 15,
                "edgeFade": false,
                "edgeFadePercent": 25,
                "edgeFadeType": "size",
                "emboss": false,
                "embossDepth": 3,
                "noise": false,
                "noiseIntensity": 0.1
  },
  
                // === CIRCULAR TEXT ===
                "circularText": {
                "topText": "SCAN ME",
                "bottomText": "MY BRAND",
                "color": "#000000",
                "fontSize": 20,
                "bold": true,
                "letterSpacing": 5,
                "margin": 10,
                "radius": 0
  },
  
                // === SCAN CORNERS ===
                "scanCorners": {
                "enabled": true,
                "color": "#6366f1",
                "style": "brackets",
                "length": 15,
                "thickness": 3,
                "offset": 10
  },
  
                // === CENTER TEXT STRIP ===
                "centerText": {
                "text": "BRAND",
                "color": "#000000",
                "backgroundColor": "#ffffff",
                "backgroundOpacity": 1.0,
                "orientation": "horizontal",
                "height": 40,
                "fontSize": 16,
                "bold": true
  },
  
                // === CTA TEXT ===
                "ctaText": "SCAN ME",
                "ctaColor": "#000000",
                "ctaFontSize": 24,
                "ctaPosition": "bottom",
                "ctaFontFamily": null
}
💡
Note: You don't need to include all parameters. Only content is required. All other parameters have sensible defaults. Include only what you want to customize.

Response (Base64 Mode)

When responseType: "base64" (default), you receive a JSON response:

200 OK — application/json
{
                "success": true,
                "qrBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
                "format": "png",
                "contentType": "image/png",
                "sizeBytes": 24680
}

Response Fields

FieldTypeDescription
successboolWhether the generation succeeded
qrBase64stringBase64-encoded file data
formatstringFile extension (png, jpg, svg, pdf, etc.)
contentTypestringMIME type for the file
sizeBytesintFile size in bytes

Response (Binary Mode)

When responseType: "binary", you receive the file directly:

200 OK — image/png (or corresponding MIME type)
// Binary file data returned directly
// Content-Disposition: attachment; filename="qrcode.png"
// Content-Type: image/png (or image/svg+xml, application/pdf, etc.)
🖼️
Displaying Base64 images: Use the Base64 string in an <img> tag:
<img src="data:{contentType};base64,{qrBase64}" />
📥
Binary mode tip: When using responseType: "binary", the response is a direct file download. In JavaScript, handle it as a Blob:
const blob = await response.blob();

Example: Download PDF

cURL - Download PDF filecURL
curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
                "content": "https://mywebsite.com",
                "fileFormat": "pdf",
                "responseType": "binary",
                "moduleShape": "circle",
                "primaryColor": "#6366f1"
  }' --output qrcode.pdf

Example: Get SVG as Base64

cURL - SVG in JSON responsecURL
curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
                "content": "https://mywebsite.com",
                "fileFormat": "svg",
                "responseType": "base64",
                "primaryColor": "#f72585"
  }'

📤 Multipart Logo Upload

Instead of using logoUrl or logoBase64, you can upload your logo directly as a binary file using multipart/form-data. This is ideal when your logo isn't publicly accessible.

Multipart Request Structure

FieldTypeDescription
config REQ text (JSON string) The complete QR configuration as a JSON string
logoFile file (binary) Logo image file (PNG, JPG, etc.). Takes priority over logoUrl/logoBase64. Max 10 MB.
backgroundFile file (binary) Background image file (PNG, JPG, etc.). Alternative to backgroundImageUrl/backgroundImageBase64. Takes priority over URL/Base64 background options. Max 10 MB.

cURL Example

Multipart RequestcURL
curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -F 'config={"content":"https://mysite.com","moduleShape":"circle","primaryColor":"#f72585"}' \
  -F "logoFile=@/path/to/logo.png"

📦 Basic Parameters

ParameterTypeDefaultDescription
content REQ string — The data to encode. Can be any text: URLs, WiFi strings, vCards, plain text, etc.
eccLevel string "H" Error correction level. Higher levels allow more damage/obstruction.
L M Q H
pixelsPerModule int 20 Base resolution. Higher = sharper. Range: 5-100
quietZone bool true Add a white margin (4 modules) around the QR for better scanning. DEPRECATED This parameter is a no-op. The quiet zone is always included automatically by QRCoder.

📐 Output & Resolution

Control the final image size, format, and response type for different use cases.

ParameterTypeDefaultDescription
outputWidth int 0 Final image width in pixels. Use 3840 for 4K. 0 = auto (based on pixelsPerModule).
outputHeight int 0 Final image height in pixels. Usually equals outputWidth for square QRs. 0 = auto.
fileFormat string "png" Output image/document format.
png jpg jpeg webp svg pdf
quality int 90 Compression quality for JPEG/WebP output. Range: 0-100. Higher = better quality, larger file. Ignored for PNG, SVG, PDF.
responseType string "base64" How to receive the generated QR code.
base64 binary

Response Types Explained

TypeResponseUse Case
base64 JSON with Base64-encoded image string Web apps, embedding in HTML, storing in databases
binary Direct file download (PNG, SVG, PDF, etc.) Direct file save, print workflows, design tools

Format Comparison

FormatTypeBest ForFeatures
PNG Raster Web, transparency needed ✅ Transparency, ✅ Logos, ✅ All shapes
JPG Raster Photos, smaller file size ❌ Transparency, ✅ Logos, ✅ All shapes
SVG Vector Scalable graphics, print ✅ Infinite scale, ❌ Logos*, ⚠️ Basic shapes only
PDF Document Print, professional sharing ✅ Print-ready, ✅ Logos, ✅ All shapes
WebP Raster Web, modern apps ✅ Small file size, ✅ Logos, ✅ All shapes
💡
SVG Note: SVG output uses QRCoder's native SVG generator which supports basic styling (colors, quiet zone) but not advanced features like custom shapes, gradients, or embedded logos. For full customization, use PNG or PDF.

🎨 Colors & Gradients

ParameterTypeDefaultDescription
primaryColor hex "#000000" Main foreground color for QR modules. Use hex format: #RRGGBB
secondaryColor hex null Gradient end color. Required when using gradient styles.
foregroundStyle string "solid" Fill style for modules.
solid linearGradient radialGradient
gradientType string "linear" Type of gradient when using gradient foregroundStyle.
linear radial
gradientDirection string "vertical" Direction for gradients.
vertical horizontal diagonal diagonal-reverse radial custom
gradientAngle float 0 Custom gradient angle in degrees when gradientDirection is "custom". Range: 0-360.
gradientColors array null Multi-color gradient. Array of hex colors, e.g., ["#FF0000", "#00FF00", "#0000FF"]. Overrides primaryColor/secondaryColor.
gradientStops array null Custom gradient stop positions. Array of floats from 0.0 to 1.0, e.g., [0.0, 0.3, 1.0]. Must match the length of the gradientColors array. When null, stops are evenly distributed.
gradientOnEyes bool false Apply the gradient to finder patterns (eyes) as well. When false, eyes use solid colors.

🔵 QR Shape (Mask)

Transform the overall shape of your QR code. Perfect for creating circular QR codes like Spotify or Pepsi style.

ParameterTypeDefaultDescription
qrShape string "square" Overall shape/mask of the QR code.
square circle roundedsquare
qrShapeRadius int 0 Corner radius when qrShape is "roundedsquare". Range: 0-50.
💡
Pro Tip: Circular QR codes (qrShape: "circle") work great with moduleShape: "circle" and concentric finder patterns for a cohesive look.

⬡ Module Shapes

Transform the individual data modules of your QR code into unique shapes.

ParameterTypeDefaultDescription
moduleShape string "square" Shape of each QR data module.
square circle roundedsquare diamond star heart hexagon leaf cross dot mosaic clipped clippedsmooth pointed pointedinward pointedsmooth pill rounded roundedinward rounded-in roundedpointed rounded-pointed circlestripe circle-zebra circlestripevertical circle-zebra-vertical japanese octagon shield arrow drop vertical-line horizontal-line edgecut teardrop plus
moduleScale float 0.85 Scale of each module relative to cell size. Range: 0.5-1.0. Lower values = more spacing between modules.
moduleRotation float 0 Rotation angle of modules in degrees. Range: 0-360. Great for diagonal effects.
moduleStyle string "solid" Rendering style of modules.
solid outline dotted
moduleOutlineWidth int 2 Stroke width when moduleStyle is "outline". Range: 1-5.
moduleSizeVariation float 0 Random size variation. Range: 0-0.5. Higher = more varied module sizes.
moduleBlendMode string "normal" Blend mode for QR modules. Controls how modules composite with the background.
normal multiply screen overlay

Module Patterns

Advanced module rendering patterns inspired by social media QR codes.

ParameterTypeDefaultDescription
modulePattern string "standard" Pattern style for rendering modules.
standard vertical-lines horizontal-lines diagonal-lines dots-random dots-gradient
💡
Best Practices: Use vertical-lines for YouTube-style QR codes, horizontal-lines for Twitter-style, and dots-random for Instagram-style. Always use eccLevel: "H" for maximum reliability.

👁️ Eye Customization

The three finder patterns (corners) can be styled globally or individually with advanced styles like concentric circles. Individual eye settings override global defaults.

Global Eye Defaults

ParameterTypeDefaultDescription
finderOuterShape string "square" Default shape for the outer frame of all finder patterns.
square circle roundedsquare diamond octagon target double
finderInnerShape string "square" Default shape for the inner pupil of all finder patterns.
square circle roundedsquare diamond star dot
finderOuterColor hex null Default outer frame color. Falls back to primaryColor if not set.
finderInnerColor hex null Default inner pupil color. Falls back to primaryColor if not set.
finderBorderRadius int 0 Corner radius for square/roundedSquare finder shapes. Range: 0-50. Higher = more rounded corners.
finderInnerScale float 0.43 Scale of inner finder relative to outer. Range: 0.25-0.55. Lower = smaller inner, more padding from outer edge.

Advanced Finder Styles

Create unique finder patterns like concentric circles (Pepsi style) or target patterns.

ParameterTypeDefaultDescription
finderStyle string "standard" Advanced rendering style for finder patterns.
standard concentric-circles target logo
finderConcentricRings int 3 Number of rings when finderStyle is "concentric-circles". Range: 2-5.
finderInnerPattern string "none" Decorative pattern inside the finder center.
none cross star dot

Individual Eye Overrides

ParameterTypeDescription
eye1 object Top-Left finder pattern override.
eye2 object Top-Right finder pattern override.
eye3 object Bottom-Left finder pattern override.

Eye Object Structure

Eye Configuration ObjectJSON
{
                "outerShape": "circle",      // Optional: "square" | "circle" | "roundedSquare" | etc.
                "innerShape": "circle",      // Optional: "square" | "circle" | "roundedSquare" | etc.
                "outerColor": "#ff0000",     // Optional: Hex color for outer frame
                "innerColor": "#0000ff",     // Optional: Hex color for inner pupil
                "rotation": 45,              // Optional: Rotation in degrees (0-360)
                "iconUrl": "https://...",   // Optional: Custom icon URL for finder center
                "iconBase64": "iVBORw..."   // Optional: Base64 icon for finder center
}

🖼️ Background Options

Customize the QR code background with solid colors, transparency, or images.

ParameterTypeDefaultDescription
backgroundColor hex "#FFFFFF" Background color in hex format.
transparentBackground bool false Make the background fully transparent. Requires PNG format for best results.
backgroundImageUrl string null URL to a background/watermark image. Image will be stretched to fill.
backgroundImageBase64 string null Base64-encoded background image. Can include or omit the data URI prefix.
backgroundOpacity float 1.0 Opacity of the background image. Range: 0.0 - 1.0
backgroundBlendMode string "behind" How the background image blends with the QR code.
behind blend
behind = image rendered behind QR modules. blend = image overlaid/blended with QR.
backgroundFit string "fill" How the background image fits within the QR canvas.
fill fit stretch tile center
backgroundPosition string "center" Position of the background image. Only applies when backgroundFit is "fit" or "center".
center top bottom left right
backgroundBlur int 0 Blur radius applied to the background image. Range: 0-50. Higher values = more blur.

🔲 Frame Options

Wrap the QR code in a decorative frame. Supports multiple shapes including speech bubbles, badges, and shields with gradient options.

ParameterTypeDefaultDescription
frame.enabled bool false Enable the decorative frame.
frame.shape string "rectangle" Frame shape style.
rectangle speechbubble badge shield
frame.color hex "#000000" Frame border color (primary color for gradients).
frame.secondaryColor hex null Secondary color for gradient frames.
frame.gradientType string "none" Gradient type for the frame border.
none linear radial
frame.fillColor hex null Background fill color inside the frame (different from QR background).
frame.blendMode string "normal" Blend mode for the frame over background.
normal multiply screen overlay ...
frame.width int 10 Border thickness in pixels.
frame.cornerRadius int 20 Rounded corner radius. Use 0 for sharp corners.
frame.style string "solid" Border line style.
solid dashed dotted double
frame.padding int 20 Space between the QR and the frame. Auto-adjusted when cornerRadius is large.

Speech Bubble Options

When using frame.shape: "speechbubble", configure the pointer direction.

ParameterTypeDefaultDescription
frame.speechBubbleDirection string "bottom" Direction of the speech bubble pointer.
bottom top left right
frame.speechBubbleSize int 20 Size of the speech bubble pointer in pixels. Range: 0-100.

✨ Visual Effects

Apply stunning visual effects to your QR code including shadows, neon glow, edge fading, and 3D emboss effects.

Shadow Effect

ParameterTypeDefaultDescription
effects.shadow bool false Enable drop shadow effect on the QR code.
effects.shadowColor hex "#00000040" Shadow color with alpha (RRGGBBAA format supported).
effects.shadowOffsetX int 5 Horizontal shadow offset in pixels.
effects.shadowOffsetY int 5 Vertical shadow offset in pixels.
effects.shadowBlur int 10 Shadow blur radius. Range: 0-50.

Neon Glow Effect

ParameterTypeDefaultDescription
effects.glow bool false Enable neon glow effect around the QR modules.
effects.glowColor hex "#00FF00" Glow color (neon effect color).
effects.glowIntensity int 10 Glow brightness intensity. Range: 1-20.
effects.glowRadius int 15 Glow expansion radius. Range: 1-50.

Edge Fade Effect

Create a dispersing/fading effect where modules gradually fade toward the edges (like Instagram QR style).

ParameterTypeDefaultDescription
effects.edgeFade bool false Enable edge fade/dispersion effect.
effects.edgeFadePercent int 25 Percentage of QR affected by fade. Range: 10-50.
effects.edgeFadeType string "size" How modules fade at edges.
size opacity both

Additional Effects

ParameterTypeDefaultDescription
effects.emboss bool false Enable 3D emboss/elevation effect.
effects.embossDepth int 3 Depth of the 3D effect. Range: 1-10.
effects.noise bool false Add subtle noise/texture to the QR.
effects.noiseIntensity float 0.1 Noise intensity. Range: 0.0-1.0.
effects.blur bool false Enable gaussian blur effect.
effects.blurRadius int 5 Blur radius in pixels. Range: 1-20.
effects.colorFilter string "none" Apply color filter.
none grayscale sepia invert high-contrast

Path Effects

Advanced stroke effects for outline-style modules and decorative patterns.

ParameterTypeDefaultDescription
effects.dashEffect bool false Enable dashed line effect for outline modules.
effects.dashLength float 5 Length of dash segments.
effects.dashGap float 3 Gap between dash segments.
effects.cornerEffect bool false Enable corner rounding for paths.
effects.cornerRadius float 5 Radius for corner smoothing.
effects.wiggleEffect bool false Enable random distortion/wiggle effect for organic look.
effects.wiggleSegmentLength float 3 Segment length for wiggle calculation.
effects.wiggleDeviation float 2 Maximum deviation for wiggle effect.
effects.dotEffect bool false Enable dotted line effect for outline modules.
effects.dotSize float 2 Size of dots in dotted effect.
effects.dotSpacing float 4 Spacing between dots.

Advanced Connectivity

Create organic, liquid, or connected designs by linking adjacent modules.

ParameterTypeDefaultDescription
connectedStyle string "none" Connection style between neighbor modules.
none fluid sharp round
connectionThreshold float 0.5 How much modules stretch to touch neighbors (0.0-1.0).
cornerRounding int 0 Radius for smoothing connections.
isolatedModuleShape string null Shape for modules without neighbors (e.g., "leaf", "circle"). Inherits moduleShape if null.

Custom SVG Shapes

Extreme customization using standard SVG path data strings.

ParameterTypeDefaultDescription
customModuleSvg string null SVG path data (d="M...") for data modules.
customFinderOuterSvg string null SVG path data for finder outer ring.
customFinderInnerSvg string null SVG path data for finder inner center.

🔄 Circular Text

Add curved text around the QR code, perfect for "SCAN ME" badges like the circular QR designs.

ParameterTypeDefaultDescription
circularText.topText string null Text displayed in a curve above the QR (e.g., "SCAN ME").
circularText.bottomText string null Text displayed in a curve below the QR.
circularText.color hex "#000000" Text color.
circularText.fontSize int 20 Font size in points.
circularText.fontFamily string null Font family name (system fonts).
circularText.bold bool true Use bold font weight.
circularText.letterSpacing int 5 Space between characters. Range: 0-50.
circularText.margin int 10 Distance from the QR edge.
circularText.radius int 0 Custom curve radius. 0 = automatic based on QR size.

📐 Scan Corners

Add decorative corner markers around the QR code, similar to camera viewfinder corners.

ParameterTypeDefaultDescription
scanCorners.enabled bool false Enable decorative scan corners.
scanCorners.color hex "#000000" Color of the corner markers.
scanCorners.style string "lines" Style of corner markers.
lines brackets dots
scanCorners.length int 15 Length of corner lines as % of QR size. Range: 5-25.
scanCorners.thickness int 3 Line thickness. Range: 1-10.
scanCorners.offset int 10 Distance from the QR edge. Range: 0-50.

✍️ Text Overlays

Center Text Strip

Add a text band that cuts through the center of the QR code.

ParameterTypeDefaultDescription
centerText.text string — Text to display across the QR.
centerText.color hex "#000000" Text color.
centerText.backgroundColor hex "#FFFFFF" Strip background color.
centerText.orientation string "horizontal" Direction of the text strip.
horizontal vertical-rotated vertical-stacked
centerText.height int 40 Thickness of the strip in pixels.
centerText.fontSize int 16 Font size in points.
centerText.bold bool true Use bold font weight.
centerText.backgroundOpacity float 1.0 Opacity of the centerText background strip. Range: 0.0 - 1.0. Use lower values for a semi-transparent text band.
centerText.paddingX int 10 Horizontal padding (in pixels) for the centerText strip. Controls spacing between text and strip edges.

Footer/Header CTA (Call to Action)

Add promotional text above or below the QR code.

ParameterTypeDefaultDescription
ctaText string null Text displayed near the QR (e.g., "SCAN ME", "Visit our website").
ctaColor hex "#000000" CTA text color.
ctaFontSize int 24 CTA font size in points. Text is always bold.
ctaPosition string "bottom" Position of the CTA text.
bottom top
ctaFontFamily string null Custom font family name (system fonts only).

📚 List Templates

GET /api/qr/templates

Retrieve the list of available pre-designed QR templates. Returns template metadata without the full configuration.

Query Parameters

ParameterTypeDescription
category OPTstringFilter templates by category (e.g., "Technology", "Luxury", "Fun")

Response

200 OK
{
                "success": true,
                "count": 12,
                "categories": ["Artistic", "Corporate", "Events", "Fun", "Luxury", "Nature", "Social", "Technology"],
                "templates": [
    {
                "id": "cyber-neon",
                "name": "Cyber Neon",
                "category": "Technology",
                "description": "Futuristic neon style with hexagon modules and cyan-pink gradient"
    },
    {
                "id": "professional-blue",
                "name": "Professional Blue",
                "category": "Corporate",
                "description": "Clean corporate style with blue gradient, ideal for business"
    },
    ...
  ]
}

🎨 Generate from Template

POST /api/qr/templates/{templateId}

Generate a QR code using a pre-designed template. You can customize the content, logo, output format, and CTA text while keeping the template's visual style intact.

URL Parameters

ParameterTypeDescription
templateId REQstringThe template identifier (e.g., "cyber-neon", "minimalist")

Request Body

ParameterTypeDefaultDescription
content REQstring—The data to encode (URL, text, etc.)
fileFormat OPTstring"png"Output format: png, jpg, svg, pdf, etc.
responseType OPTstring"base64"Response type: base64 or binary
outputWidth OPTint0Output width in pixels (0 = auto)
outputHeight OPTint0Output height in pixels (0 = auto)
logoUrl OPTstringnullURL of logo to embed in QR center
logoBase64 OPTstringnullBase64-encoded logo image
backgroundImageUrl OPTstringnullURL of background image (for Background Integration templates)
backgroundImageBase64 OPTstringnullBase64-encoded background image
ctaText OPTstringnullCall-to-action text below QR (e.g., "SCAN ME")
💡
Template Protection: Visual style properties (colors, shapes, gradients, frames) are locked to the template design. You can only customize content-related properties like the encoded data, logo, output format, and CTA text.

Example Request

Generate QR from TemplatecURL
curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/templates/cyber-neon" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
                "content": "https://mycompany.com",
                "logoUrl": "https://mycompany.com/logo.png",
                "ctaText": "SCAN ME",
                "fileFormat": "png",
                "outputWidth": 1024
  }'

Multipart Upload (with Logo File)

Template with Logo File UploadcURL
curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/templates/premium-gold" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -F 'config={"content":"https://luxury-brand.com","ctaText":"DISCOVER MORE"}' \
  -F "logoFile=@/path/to/logo.png"

Response

200 OK
{
                "success": true,
                "qrBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
                "format": "png",
                "contentType": "image/png",
                "sizeBytes": 24680
}

Error: Template Not Found

404 Not FoundJSON
{
                "success": false,
                "error": {
                "code": "TEMPLATE_NOT_FOUND",
                "message": "Template 'unknown-template' not found. Use GET /api/qr/templates to see available templates.",
                "field": "templateId"
  }
}

🎨 Pattern Gallery

Visual reference for all available patterns. Use these shape names in your API requests.

Module Shapes (moduleShape)

Shape of individual data modules in the QR code.

square square
circle circle
roundedsquare roundedsquare
diamond diamond
star star
heart heart
hexagon hexagon
leaf leaf
cross cross
dot dot
mosaic mosaic
clipped clipped
clippedsmooth clippedsmooth
pointed pointed
pointedinward pointedinward
pointedsmooth pointedsmooth
pill pill
roundedinward roundedinward
roundedpointed roundedpointed
circlestripe circlestripe
japanese japanese
octagon octagon
shield shield
arrow arrow
drop drop

Finder Outer Shapes (finderOuterShape)

Shape of the outer frame of the three corner finder patterns (eyes).

square square
circle circle
roundedsquare roundedsquare
diamond diamond
octagon octagon
target target
double double

Finder Inner Shapes (finderInnerShape)

Shape of the inner dot/center of the finder patterns (eyeballs).

square square
circle circle
roundedsquare roundedsquare
diamond diamond
star star
dot dot
💡
Custom Patterns: You can also provide custom SVG paths using customModuleSvg, customFinderOuterSvg, and customFinderInnerSvg parameters for completely unique designs.

🖼️ Template Gallery

Browse our curated collection of pre-designed QR templates. Each template is ready to use with the POST /api/qr/templates/{templateId} endpoint. Click on any template to see its ID.

Art & Design

Outline Sketch Template
Outline Sketch
outline-sketch
Hand-drawn sketch look with dash and wiggle effects
Scattered Dots Template
Scattered Dots
scattered-dots
Playful scattered dots with radial gradient and size variation
Rotated Grid Template
Rotated Grid
rotated-grid
Geometric 45-degree rotated modules with corner rounding effect
Dotted Border Template
Dotted Border
dotted-border
Artistic dot-effect modules with dashed border frame
Geometric Dark Template
Geometric Dark
geometric-dark
Bold geometric triangles on dark background for modern brands
Gradient Art Template
Gradient Art
gradient-art
Abstract gradient mesh background for creative and artistic brands
Art Gallery Template
Art Gallery
art-gallery
Artistic warm design for galleries and museums
Photography Studio Template
Photography Studio
photography-studio
Minimalist black and white design for photography portfolios

Artistic

Fluid Pink Template
Fluid Pink
fluid-pink
Ultra-fluid liquid design with purple gradients and circular isolated dots
Watercolor Dream Template
Watercolor Dream
watercolor-dream
Soft watercolor-inspired pastel gradient with sepia filter
Aurora Borealis Template
Aurora Borealis
aurora-borealis
Magical northern lights gradient in greens and purples
Sunset Template
Sunset
sunset
Warm sunset colors with orange-gold vertical gradient
Mosaic Art Template
Mosaic Art
mosaic-art
Artistic mosaic pattern with clipped corners for a tiled look
Pointed Star Template
Pointed Star
pointed-star
Dynamic pointed modules creating a starburst effect
Dotted Frame Template
Dotted Frame
dotted-frame
Circular dots with decorative dotted frame border

Automotive

Car Dealership Template
Car Dealership
car-dealership
Sleek metallic design for car dealerships
Racing Speed Template
Racing Speed
racing-speed
High-energy racing style with red and black
Electric Vehicle Template
Electric Vehicle
electric-vehicle
Modern eco-friendly style for electric vehicles

Background

Watermark Brand Template
Watermark Brand
watermark-brand
Semi-transparent dark design to overlay on brand watermarks
Vivid Canvas Template
Vivid Canvas
vivid-canvas
Bright white circles designed for colorful brand photography

Business

Transparent Overlay Template
Transparent Overlay
transparent-overlay
Transparent background QR for overlaying on images and designs

Corporate

Professional Blue Template
Professional Blue
professional-blue
Clean corporate style with blue gradient, ideal for business
Corporate Red Template
Corporate Red
corporate-red
Bold red corporate design for impactful business branding
Enterprise Gray Template
Enterprise Gray
enterprise-gray
Sophisticated grayscale design for enterprise and consulting firms
Shield Badge Template
Shield Badge
shield-badge
Official shield-shaped design for security and trust

Culture

Japanese Zen Template
Japanese Zen
japanese-zen
Minimalist Japanese-inspired design with unique corner modules

Education

University Classic Template
University Classic
university-classic
Traditional academic style with navy blue and gold accents
Kids Learning Template
Kids Learning
kids-learning
Fun and colorful design for children's education
Online Course Template
Online Course
online-course
Modern digital learning platform design

Events

Valentine Heart Template
Valentine Heart
valentine-heart
Romantic heart-shaped modules on soft pink background
Party Confetti Template
Party Confetti
party-confetti
Colorful party design with star modules for celebrations
Wedding Elegant Template
Wedding Elegant
wedding-elegant
Sophisticated design for wedding invitations and ceremonies
Concert Ticket Template
Concert Ticket
concert-ticket
Vibrant neon design for concert and event tickets
Wedding Invitation Template
Wedding Invitation
wedding-invitation
Romantic design for wedding invitations and save-the-dates
Sports Event Template
Sports Event
sports-event
Dynamic design for sports events and competitions
Floral Event Template
Floral Event
floral-event
Delicate floral pattern for weddings, invitations and elegant events

Finance

Payment Wallet Template
Payment Wallet
payment-wallet
Payment and digital wallet QR with money-green theme and badge frame
Venmo Send Template
Venmo Send
venmo-send
Venmo-inspired clean blue design for peer-to-peer payments
Bitcoin Pay Template
Bitcoin Pay
bitcoin-pay
Orange Bitcoin logo design for crypto payments and wallet addresses
Accounting Pro Template
Accounting Pro
accounting-pro
Clean dark green design for accounting and financial services
Insurance Trust Template
Insurance Trust
insurance-trust
Professional blue and white design for insurance companies

Food & Drink

Food Delivery Template
Food Delivery
food-delivery
Warm appetizing design for food delivery and restaurant ordering
WiFi Cafe Template
WiFi Cafe
wifi-cafe
Warm coffee-themed WiFi sharing QR for cafes and bistros
Bakery Sweet Template
Bakery Sweet
bakery-sweet
Warm pastel design for bakeries and dessert shops
Craft Brewery Template
Craft Brewery
craft-brewery
Rustic amber and brown design for craft breweries

Fun

Retro 8-Bit Template
Retro 8-Bit
retro-8bit
Classic arcade green on black with pixelated style
Neon Nights Template
Neon Nights
neon-nights
Vibrant neon colors for nightclubs and entertainment venues
Bubblegum Pop Template
Bubblegum Pop
bubblegum-pop
Playful pink and blue pastel design for youth-oriented brands
Wiggle Fun Template
Wiggle Fun
wiggle-fun
Playful hand-drawn effect with wiggle distortion

Health

Gym Fitness Template
Gym Fitness
gym-fitness
Bold energetic fitness design with gradient and scan corners
Pet Veterinary Template
Pet Veterinary
pet-veterinary
Friendly green design for veterinary clinics and pet care
Spa Wellness Template
Spa Wellness
spa-wellness
Calming teal and lavender design for spa and wellness centers
Yoga Meditation Template
Yoga Meditation
yoga-meditation
Peaceful orange and warm design for yoga studios

Healthcare

Pharmacy Trust Template
Pharmacy Trust
pharmacy-trust
Professional teal design for pharmacies
Dental Clean Template
Dental Clean
dental-clean
Fresh white and blue for dental practices
Hospital Emergency Template
Hospital Emergency
hospital-emergency
Clear red cross design for hospital emergency services

Industry

Healthcare Clean Template
Healthcare Clean
healthcare-clean
Clean cross-pattern modules for medical and healthcare industry
Real Estate Premium Template
Real Estate Premium
real-estate-premium
Elegant gold and black design for luxury real estate

Legal

Law Firm Classic Template
Law Firm Classic
law-firm-classic
Conservative dark blue design for law firms and legal services

Luxury

Premium Gold Template
Premium Gold
premium-gold
Luxurious radial gold gradient with embossed 3D effect
Luxury Overlay Template
Luxury Overlay
luxury-overlay
Elegant gold on dark with overlay blend mode for rich textures
Minimalist Template
Minimalist
minimalist
Clean and simple black on white with rounded modules
Rose Gold Template
Rose Gold
rose-gold
Elegant rose gold gradient for premium feminine brands
Marble Luxury Template
Marble Luxury
marble-luxury
Elegant marble texture background for premium and luxury brands

Marketing

Scan Me Badge Template
Scan Me Badge
scan-me-badge
High conversion circular design with 'SCAN ME' call to action
Center Promo Template
Center Promo
center-promo
Promotional design with prominent center text and glow effects

Music

Spotify Vibes Template
Spotify Vibes
spotify-vibes
Modern music-inspired design with Spotify green and dark theme
Soundwave Purple Template
Soundwave Purple
soundwave-purple
Deep purple gradient inspired by electronic music and DJs
Vinyl Classic Template
Vinyl Classic
vinyl-classic
Retro vinyl record aesthetic for music lovers and record stores
Music Stream Template
Music Stream
music-stream
Green music note design for streaming links and playlists

Nature

Organic Leaf Template
Organic Leaf
organic-leaf
Fluid organic design with connected modules and leaf-shaped isolated elements
Forest Wood Template
Forest Wood
forest-wood
Earthy brown tones inspired by natural wood textures
Ocean Breeze Template
Ocean Breeze
ocean-breeze
Calming ocean blue gradient with circular modules
Organic Flow Template
Organic Flow
organic-flow
Fluid connected design with leaf shapes for eco-friendly brands
Water Drop Template
Water Drop
drop-water
Elegant water drop modules with blue gradient for water/wellness brands

Non-Profit

Charity Donate Template
Charity Donate
charity-donate
Warm and welcoming heart-shaped design for charitable donations
Pet Adoption Template
Pet Adoption
pet-adoption
Playful and colorful star-shaped design for pet adoption campaigns

Real Estate

Real Estate Luxury Template
Real Estate Luxury
real-estate-luxury
Elegant gold and navy design for luxury property listings

Restaurant

Restaurant Menu Template
Restaurant Menu
restaurant-menu
Elegant restaurant menu style with warm colors and frame
Coffee Shop Template
Coffee Shop
coffee-shop
Warm coffee tones with bean-inspired design
Organic Food Template
Organic Food
organic-food
Natural green design for organic and eco-friendly food brands
Pizzeria Template
Pizzeria
pizzeria
Italian-style design with warm red and cream colors
Coffee Logo
coffee-logo
Warm coffee-themed design with cup logo for cafes and bakeries
Restaurant Logo
restaurant-logo
Elegant red design with fork and knife logo for restaurant menus

Retail

Black Friday Template
Black Friday
black-friday
Bold black and gold for Black Friday sales
Summer Sale Template
Summer Sale
summer-sale
Vibrant summer colors for seasonal promotions
Boutique Chic Template
Boutique Chic
boutique-chic
Minimalist rose gold design for fashion boutiques
Discount Code Template
Discount Code
discount-code
Eye-catching design for discount codes and coupons
Retail Shop Template
Retail Shop
retail-shop
Vibrant purple shopping bag design for retail stores and e-commerce
Fashion Minimal Template
Fashion Minimal
fashion-minimal
High fashion minimalist design for luxury fashion brands
Florist Garden Template
Florist Garden
florist-garden
Fresh green and pink design for florists and garden shops

Social

Neon Cyberpunk Template
Neon Cyberpunk
neon-cyberpunk
Electric neon glow with cyberpunk aesthetic - high contrast futuristic design
Influencer Gradient Template
Influencer Gradient
influencer-gradient
Instagram-style gradient with soft focus effect
TikTok Viral Template
TikTok Viral
tiktok-viral
Vibrant TikTok-inspired design with signature cyan-pink-black palette
LinkedIn Pro Template
LinkedIn Pro
linkedin-pro
Professional LinkedIn blue for networking and business connections

Social Media

Speech Bubble Chat Template
Speech Bubble Chat
speech-bubble-chat
Chat-style speech bubble frame inspired by messaging apps
YouTube Subscribe Template
YouTube Subscribe
youtube-subscribe
YouTube-inspired bold red design to drive channel subscriptions
WhatsApp Contact Template
WhatsApp Contact
whatsapp-contact
WhatsApp-green QR with speech bubble frame for quick contact sharing
Twitter X Follow Template
Twitter X Follow
twitter-x-follow
Minimalist black and white X/Twitter design for profile follows
Discord Server Template
Discord Server
discord-server
Discord blurple design with glow for server invite links

Technology

Cyber Neon Template
Cyber Neon
cyber-neon
Futuristic glowing neon style with diamond modules and vibrant cyan-pink gradient
Matrix Code Template
Matrix Code
matrix-code
Digital rain effect with vertical green lines on black
Developer Dark Template
Developer Dark
developer-dark
Dark theme inspired by code editors with VS Code colors
AI Neural Template
AI Neural
ai-neural
Futuristic AI-inspired design with purple neural network vibes
Bitcoin Classic Template
Bitcoin Classic
bitcoin-classic
Classic Bitcoin orange to black vertical gradient design
Hextech Grid Template
Hextech Grid
hextech-grid
Futuristic hexagonal modules with gear-shaped finders and cyan glow
Octagon Tech Template
Octagon Tech
octagon-tech
Sharp octagonal modules with double-line frame for tech companies
Scan Bracket Template
Scan Bracket
scan-bracket
Clean minimal design with bracket-style scan corner decorators
Gaming Esports Template
Gaming Esports
gaming-esports
Aggressive neon esports design with glow and scan corners
NFT Mint Template
NFT Mint
nft-mint
Multi-color Web3 and NFT design with vibrant gradient and glow
WiFi Hotspot Template
WiFi Hotspot
wifi-hotspot
Clean WiFi icon design perfect for restaurants, hotels and public spaces
Circuit Board Template
Circuit Board
circuit-tech
Futuristic circuit board pattern for tech companies and startups
Esports Gaming Template
Esports Gaming
esports-gaming
Neon purple and cyan design for esports and gaming events
Startup Tech Template
Startup Tech
startup-tech
Modern gradient design for tech startups

Travel

Hotel Luxury Template
Hotel Luxury
hotel-luxury
Premium hotel style with gold on black elegance
Travel Adventure Template
Travel Adventure
travel-adventure
Vibrant sunset gradient for travel agencies and tours
Airline Modern Template
Airline Modern
airline-modern
Clean airline style with sky blue gradient
WiFi Hotel Template
WiFi Hotel
wifi-hotel
Luxury gold and navy hotel WiFi QR with elegant framing

🤖 AI-Powered QR Generation

POST /api/qr/ai/generate

Generate a custom QR code by describing it in natural language. The AI will interpret your description and create the perfect configuration using all available styling options. Just describe the style, colors, mood, and brand identity - the AI handles the rest!

🌟
Bring Your Own Key: This endpoint requires your own LLM API key (OpenAI, Anthropic, Google, etc.). Your key is never stored - it's used only for the request.

Supported LLM Providers

ProviderIDAvailable Models
OpenAIopenaigpt-5.2, gpt-4.1, gpt-4.1-mini, gpt-4.1-nano, o3, o3-mini, o4-mini
Anthropicanthropicclaude-opus-4-6, claude-sonnet-4-6, claude-haiku-4-5
Google Geminigooglegemini-3.1-pro-preview, gemini-2.5-pro, gemini-2.5-flash, gemini-2.0-flash
Mistral AImistralmistral-large-latest, mistral-medium-latest, mistral-small-latest, magistral-medium-2509
Coherecoherecommand-a-03-2025, command-r-plus-08-2024
Groqgroqllama-3.3-70b-versatile, llama-4-scout-17b, deepseek-r1-distill-llama-70b, qwen3-32b

Request Body

ParameterTypeDefaultDescription
prompt REQstring—Natural language description of how you want the QR to look. Be specific about colors, style, mood, shapes, effects, etc.
content REQstring—The data to encode (URL, text, etc.)
llmProvider REQstring—LLM provider ID: openai, anthropic, google, mistral, cohere, groq
llmApiKey REQstring—Your API key for the selected LLM provider
llmModel OPTstringvariesSpecific model to use. If not provided, uses the provider's default model.
fileFormat OPTstring"png"Output format: png, jpg, svg, pdf, etc.
responseType OPTstring"base64"Response type: base64 or binary
outputWidth OPTint0Output width in pixels (0 = auto)
outputHeight OPTint0Output height in pixels (0 = auto)
logoUrl OPTstringnullURL of logo to embed in QR center
logoBase64 OPTstringnullBase64-encoded logo image
backgroundImageUrl OPTstringnullURL of background image
backgroundImageBase64 OPTstringnullBase64-encoded background image
ctaText OPTstringnullCall-to-action text (e.g., "SCAN ME")
creativity OPTfloat0.5AI creativity level (0.0-1.0). 0 = conservative/minimal, 1 = highly creative/artistic. Affects LLM temperature and design decisions.
strictScannability OPTbooleantrueWhen true, AI prioritizes QR readability over visual creativity. Recommended for production use.
stylePreset OPTstring"balanced"Style preset to guide AI: minimal, balanced, artistic, corporate, playful, luxury, tech, nature

Example Request

AI QR GenerationcURL
curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/ai/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Create a modern tech startup QR code with a gradient from electric blue to purple, circular modules, neon glow effect, dark background, and rounded finder patterns. Make it look futuristic and premium.",
    "content": "https://mycompany.com",
    "llmProvider": "openai",
    "llmApiKey": "sk-your-openai-api-key",
    "llmModel": "gpt-4.1-mini",
    "logoUrl": "https://mycompany.com/logo.png",
    "ctaText": "SCAN TO CONNECT"
  }'

Example Response

JSON ResponseJSON
{
  "success": true,
  "qrBase64": "iVBORw0KGgoAAAANSUhEUgAAA...",
  "format": "png",
  "contentType": "image/png",
  "sizeBytes": 45892,
  "generatedConfig": {
    "primaryColor": "#0066FF",
    "secondaryColor": "#9933FF",
    "foregroundStyle": "linearGradient",
    "gradientDirection": "diagonal",
    "backgroundColor": "#0a0a12",
    "moduleShape": "circle",
    "finderOuterShape": "roundedsquare",
    "finderInnerShape": "circle",
    "finderBorderRadius": 15,
    "effects": {
      "glow": true,
      "glowColor": "#0066FF",
      "glowIntensity": 12
    }
  },
  "aiExplanation": "Created a futuristic design with blue-to-purple gradient, circular modules for a modern feel, and neon glow effect on a dark background to achieve the premium tech aesthetic.",
  "llmProviderUsed": "openai",
  "llmModelUsed": "gpt-4.1-mini"
}

Prompt Tips

✨
Write Better Prompts:
  • Be specific about colors: "electric blue", "rose gold", "forest green"
  • Describe the mood: "professional", "playful", "luxurious", "minimalist"
  • Mention your industry: "tech startup", "wedding invitation", "restaurant menu"
  • Request specific effects: "neon glow", "drop shadow", "3D emboss"
  • Specify shapes: "circular modules", "heart-shaped finders", "diamond pattern"
  • Reference styles: "Instagram-like gradient", "Spotify green theme", "TikTok colors"

📋 List AI Providers

GET /api/qr/ai/providers

Get the list of supported LLM providers and their available models.

Example Request

List AI ProviderscURL
curl -X GET "https://qr-branding-api.p.rapidapi.com/api/qr/ai/providers" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com"

Example Response

JSON ResponseJSON
{
  "success": true,
  "count": 6,
  "providers": [
    {
      "id": "openai",
      "name": "OpenAI",
      "defaultModel": "gpt-4.1-mini",
      "availableModels": ["gpt-5.2", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "o3", "o3-mini", "o4-mini"]
    },
    {
      "id": "anthropic",
      "name": "Anthropic",
      "defaultModel": "claude-sonnet-4-6",
      "availableModels": ["claude-opus-4-6", "claude-sonnet-4-6", "claude-haiku-4-5"]
    },
    {
      "id": "google",
      "name": "Google Gemini",
      "defaultModel": "gemini-2.5-flash",
      "availableModels": ["gemini-3.1-pro-preview", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.0-flash"]
    }
  ]
}

🤖 AI Generation Gallery

Real examples generated using our AI endpoint. See the prompt that created each design.

Aurora_Borealis_Magic

Aurora Borealis Magic

Nature
View Prompt

Create a mesmerizing aurora borealis inspired QR code. Use a gradient flowing from electric teal (#00ffd5) to ethereal green (#39ff14). Circular modules. Dark midnight background (#050510). Add a magical glow effect with the teal color. Finder patterns should be roundedsquare with bright cyan (#00ffd5) for visibility.

💬 A mesmerizing aurora borealis design with a vertical gradient flowing from electric teal to ethereal green, evoking the natural curtains of northern lights against a deep midnight sky. Circular modules mimic celestial particles, while the teal glow and diffused shadow create an otherworldly luminescence. Bright cyan finder patterns in roundedsquare form ensure excellent contrast and reliable scanning against the dark background.

⏱️ 8845ms 📦 261.053 bytes
Liquid_Metal_Chrome

Liquid Metal Chrome

Industrial
View Prompt

Design a futuristic liquid metal chrome QR code. Dark steel (#333333) to metallic gray (#555555) radial gradient. Diamond-shaped modules for crystalline tech feel. Light silver background (#E8E8E8). Add emboss effect for 3D depth. Rounded square finders in dark charcoal (#222222). Include a sleek frame.

💬 Futuristic liquid metal design using a dark steel-to-metallic gray radial gradient with diamond modules for a crystalline tech aesthetic. The emboss effect adds convincing 3D depth mimicking chrome relief, while the subtle drop shadow enhances the metallic illusion. Dark charcoal rounded-square finders ensure strong contrast against the light silver background for reliable scanning, and the sleek gradient frame with soft corners completes the polished industrial look.

⏱️ 7870ms 📦 67.201 bytes
Bioluminescent_Ocean

Bioluminescent Ocean

Nature
View Prompt

Create a deep sea bioluminescent QR code. Gradient from electric cyan (#00ffff) to glowing blue (#0066ff). Circle modules like plankton particles. Very dark ocean background (#000022). Glow effect with cyan color. Finder patterns with bright cyan outer (#00ffff).

💬 Deep sea bioluminescent design featuring circular plankton-like modules with a cyan-to-blue gradient drifting downward like light through ocean depths. The cyan glow effect and soft luminous shadow simulate the ethereal bioluminescence of deep-sea organisms against the near-black ocean abyss background. Finder patterns use bright cyan for maximum contrast and scanner reliability.

⏱️ 6686ms 📦 269.754 bytes
Neon_Tokyo_Night

Neon Tokyo Night

Tech
View Prompt

Design a cyberpunk neon Tokyo QR code. Gradient from electric pink (#FF0080) to neon blue (#0080FF). Roundedsquare modules. Very dark background (#0A0A1A). Glow effect with pink color. Finder patterns roundedsquare with neon pink outer (#FF0080) and cyan inner (#00FFFF). Add a solid frame with rounded corners.

💬 Cyberpunk Tokyo-inspired design featuring an electric pink-to-neon blue diagonal gradient on an ultra-dark background, with glowing pink aura and neon finder patterns in hot pink and cyan for that authentic night-city holographic feel. The gradient frame and rounded shapes complete the futuristic aesthetic while maintaining strong contrast for reliable scanning.

⏱️ 7854ms 📦 487.901 bytes
Synthwave_Sunset

Synthwave Sunset

Creative
View Prompt

Create an 80s synthwave sunset QR code. Gradient: hot pink (#FF1493), electric orange (#FF4500). Hexagon modules for retro-futuristic feel. Deep purple-black background (#1a0033). Glow effect with pink. Rounded square finders with bright pink (#FF1493).

💬 80s synthwave sunset design with a hot pink-to-electric orange gradient flowing top to bottom like a retro sunset horizon. Hexagon modules deliver that retro-futuristic grid aesthetic against the deep purple-black void. Pink neon glow radiates off the modules for authentic synthwave atmosphere, while bright pink rounded-square finders ensure strong contrast against the dark background for reliable scanning. A gradient frame ties the whole vaporwave vibe together.

⏱️ 8996ms 📦 415.890 bytes
Volcanic_Ember

Volcanic Ember

Creative
View Prompt

Design a volcanic lava themed QR code. Gradient from bright orange (#FF6600) to crimson (#CC0000). Diamond-shaped modules like sparks. Very dark charcoal background (#111111). Shadow effect for depth. Finder patterns with bright orange outer (#FF6600) and yellow inner (#FFCC00).

💬 Volcanic lava design with a bright orange-to-crimson gradient flowing downward like molten lava, diamond-shaped modules evoking flying sparks, and a subtle fiery glow against the dark charcoal background. The warm orange and yellow finder patterns ensure strong contrast and reliable scanning, while the shadow and glow effects add smoldering depth to the composition.

⏱️ 6978ms 📦 382.588 bytes
Arctic_Frost

Arctic Frost

Creative
View Prompt

Create an icy arctic frost QR code. Gradient from deep blue (#1E90FF) to navy (#000080). Diamond modules like ice crystals. White background (#FFFFFF). Emboss for frozen 3D texture. Finder patterns with dark navy (#000066).

💬 Arctic frost design with diamond-shaped modules evoking ice crystals, a deep blue-to-navy vertical gradient mimicking frozen depths, emboss for a 3D icy texture, and a subtle blue shadow for a frosty glow. Dark navy finder patterns ensure strong contrast against the white background for reliable scanning.

⏱️ 6798ms 📦 93.921 bytes
Tropical_Paradise

Tropical Paradise

Creative
View Prompt

Create a vibrant tropical paradise QR code. Gradient from turquoise (#00CED1) to coral (#FF6F61). Circle modules. White background (#FFFFFF). Finder patterns roundedsquare with deep teal outer (#008080) and coral inner (#FF6F61). Solid frame in teal with rounded corners.

💬 A vibrant tropical paradise design featuring a turquoise-to-coral diagonal gradient across circular modules, evoking ocean waters meeting sunset skies. Deep teal rounded-square finder patterns with coral inner dots anchor the design, while a matching teal frame with smooth rounded corners frames the whole composition like a postcard from paradise.

⏱️ 6163ms 📦 132.099 bytes
Quantum_Hologram

Quantum Hologram

Creative
View Prompt

Design a quantum holographic QR code. Gradient from cyan (#00FFFF) to magenta (#FF00FF). Hexagonal modules like data particles. Near-black background (#050510). Glow effect with cyan. Target-style finder patterns with bright cyan outer.

💬 Quantum holographic design featuring hexagonal data-particle modules with a cyan-to-magenta diagonal gradient on a near-black void background. Target-style finder patterns in bright cyan and magenta ensure strong scanner detection against the dark field. A subtle cyan glow and zero-offset shadow create the holographic light-emission effect, while light embossing adds dimensional depth to the particle grid.

⏱️ 8869ms 📦 322.210 bytes
Art_Deco_Elegance

Art Deco Elegance

Artistic
View Prompt

Design an Art Deco inspired QR code. Gradient from deep black (#1A1A2E) to midnight blue (#16213E). Diamond modules for geometric precision. Champagne gold background (#F5E6CC). Finder patterns square with black outer (#1A1A2E) and gold inner (#D4AF37). Elegant double frame in gold. Emboss effect.

💬 An Art Deco–inspired design pairing deep black-to-midnight-blue diamond modules against a warm champagne gold background for strong contrast and geometric elegance. The gold inner finder dots and double gold frame evoke the opulence of the 1920s, while the subtle emboss and shadow effects add dimensional depth reminiscent of engraved metalwork.

⏱️ 6401ms 📦 77.987 bytes
Nebula_Cosmos

Nebula Cosmos

Creative
View Prompt

Create a cosmic nebula QR code. Gradient from deep purple (#4A0080) to electric violet (#8B00FF). Circle modules like stars. Very dark background (#050510). Glow effect with violet color. Finder patterns circle with bright purple outer (#9B30FF) and white inner.

💬 A cosmic nebula design using a radial gradient from electric violet to deep purple, mimicking the swirling glow of a nebula. Circle modules evoke distant stars scattered across the ultra-dark space background (#050510). The violet glow effect creates a luminous aura, while bright purple finder outers with white inners ensure strong contrast and reliable scanning against the dark void.

⏱️ 7938ms 📦 477.437 bytes
Steampunk_Gears

Steampunk Gears

Creative
View Prompt

Design a steampunk mechanical QR code. Gradient from bronze (#CD7F32) to dark copper (#8B4513). Hexagon modules like gear teeth. Aged parchment background (#F5DEB3). Emboss effect for 3D metallic depth. Finder patterns roundedsquare with dark brown outer (#5C3317) and bronze inner (#CD7F32). Solid frame in dark brown.

💬 Steampunk mechanical design featuring a bronze-to-dark-copper vertical gradient over hexagonal gear-tooth modules on an aged parchment background. The emboss effect with a subtle drop shadow creates convincing 3D metallic depth, while dark brown finder patterns and a matching solid frame evoke the look of a Victorian brass instrument. Contrast between the dark copper/bronze modules and the light parchment ensures reliable scanning.

⏱️ 7832ms 📦 113.367 bytes
Underwater_Coral

Underwater Coral

Creative
View Prompt

Create a coral reef themed QR code. Gradient from ocean blue (#006994) to seafoam green (#2E8B57). Circle modules like bubbles. Light aqua background (#E0F7FA). Finder patterns circle with deep blue outer (#003366) and coral inner (#FF7F50). Solid frame in deep blue with rounded corners.

💬 A coral reef-inspired design with circular bubble-like modules flowing from ocean blue to seafoam green, evoking underwater currents. The deep navy finder patterns with coral-colored centers mimic the vibrant contrast of a reef, while the light aqua background and rounded deep blue frame create the feel of peering through a porthole into the ocean. A subtle shadow adds depth to the underwater atmosphere.

⏱️ 14646ms 📦 81.537 bytes
Desert_Mirage

Desert Mirage

Creative
View Prompt

Design a desert sunset mirage QR code. Gradient from warm amber (#FF8C00) to terracotta (#E2725B). Diamond modules like sand crystals. Light sand background (#FFF8DC). Shadow effect for depth. Finder patterns roundedsquare with burnt sienna outer (#A0522D) and amber inner (#FFBF00). Solid frame in terracotta.

💬 A desert sunset mirage design featuring a warm amber-to-terracotta vertical gradient evoking the horizon at dusk, with diamond-shaped modules reminiscent of glittering sand crystals against a light cornsilk sand background. Burnt sienna and amber finder patterns anchor the composition like desert rock formations, while a terracotta frame and subtle warm shadow add depth and the illusion of heat shimmer.

⏱️ 8991ms 📦 309.119 bytes
Digital_Rain

Digital Rain

Tech
View Prompt

Create a Matrix-style digital rain QR code. Gradient from bright green (#00FF41) to dark emerald (#004D00). Square modules. Very dark background (#000800). Glow effect with green color. Finder patterns square with neon green outer (#00FF41) and dark green inner (#003300). Scan corners with green brackets.

💬 Matrix digital rain aesthetic achieved with a vertical bright-to-dark green gradient simulating cascading code on an ultra-dark background. The neon green glow and matching scan corner brackets reinforce the cyberpunk terminal feel, while square modules evoke the iconic monospace character grid of the Matrix. High contrast between #00FF41 finders and the #000800 background ensures reliable scanning.

⏱️ 7628ms 📦 192.894 bytes

📶 Generate WiFi String

POST /api/qr/content/wifi

Generate a WiFi connection string that users can scan to auto-connect to a network.

Request Parameters

ParameterTypeDefaultDescription
ssid REQ string — Network name (SSID).
password REQ string — Network password.
encryption string "WPA" Encryption type.
WPA WPA2 WEP nopass
hidden bool false Whether the network SSID is hidden.
RequestJSON
{
                "ssid": "MyNetwork",
                "password": "secret123",
                "encryption": "WPA",
                "hidden": false
}
200 OK
{
                "text": "WIFI:S:MyNetwork;T:WPA;P:secret123;H:false;;"
}

👤 Generate vCard String

POST /api/qr/content/vcard

Generate a vCard contact string that adds contact info directly to the scanner's address book.

Request Parameters

ParameterTypeDescription
firstNamestringFirst name
lastNamestringLast name
phonestringPhone number (include country code)
emailstringEmail address
orgstringOrganization/Company name
urlstringWebsite URL
RequestJSON
{
                "firstName": "John",
                "lastName": "Doe",
                "phone": "+1234567890",
                "email": "john@example.com",
                "org": "Acme Inc",
                "url": "https://example.com"
}
200 OK
{
                "text": "BEGIN:VCARD\nVERSION:3.0\nN:Doe;John\nFN:John Doe\nORG:Acme Inc\nTEL:+1234567890\nEMAIL:john@example.com\nURL:https://example.com\nEND:VCARD"
}

📍 Generate Geo String

POST /api/qr/content/geo

Generate a geographic location string that opens the location in the user's maps app.

Request Parameters

ParameterTypeDescription
lat REQdoubleLatitude coordinate
lng REQdoubleLongitude coordinate
RequestJSON
{
                "lat": 40.7128,
                "lng": -74.0060
}
200 OK
{
                "text": "geo:40.7128,-74.006"
}

⚠️ Error Codes Reference

The API uses standardized error responses across all endpoints. Every error response includes a structured JSON body with detailed information to help you debug and handle errors gracefully.

Error Response Format

Error Response StructureJSON
{
                "success": false,
                "error": {
                "code": "ERROR_CODE",
                "message": "Human-readable error description",
                "field": "fieldName",         // Optional: affected field
                "details": [...]              // Optional: multiple validation errors
  }
}

HTTP Status Codes

CodeStatusDescription
200OKRequest successful
400Bad RequestInvalid input, validation error, or malformed JSON
401UnauthorizedMissing or invalid API authentication
404Not FoundResource or endpoint not found
500Internal ErrorServer-side error during processing

Validation Errors (400)

These errors occur when input data doesn't meet the required format or constraints.

Error CodeDescriptionExample
VALIDATION_ERROR General validation failure (may contain multiple errors) Validation failed with 3 errors.
INVALID_JSON Request body is not valid JSON Invalid JSON body: Unexpected character at position 45
MISSING_REQUIRED_FIELD A required field is missing or empty The 'content' field is required and cannot be empty.
INVALID_FIELD_VALUE Field value is not one of the allowed values Invalid logo shape 'triangle'. Allowed: square, circle.
INVALID_COLOR_FORMAT Color is not a valid hex format Invalid color format for 'primaryColor': 'red'. Use hex format (#RGB, #RRGGBB, or #RRGGBBAA).
INVALID_FILE_FORMAT Unsupported file format requested Invalid file format 'xyz'. Allowed: png, jpg, jpeg, webp, svg, pdf.
CONTENT_TOO_LONG QR content exceeds maximum length Content length (5000) exceeds maximum allowed (4296 characters).
FILE_TOO_LARGE Uploaded file exceeds size limit Logo file size (15728640 bytes) exceeds maximum allowed (10MB).
INVALID_URL URL format is invalid Invalid URL format for 'logoUrl'. URL must start with http:// or https://.
INVALID_ECC_LEVEL Invalid error correction level Invalid ECC level 'X'. Allowed values: L, M, Q, H.
INVALID_MODULE_SHAPE Invalid module shape specified Invalid module shape 'triangle'. Allowed: square, circle, roundedsquare, diamond, star, heart, hexagon, leaf.
INVALID_GRADIENT_TYPE Invalid gradient type Invalid gradient type 'conic'. Allowed: linear, radial.
INVALID_RESPONSE_TYPE Invalid response type requested Invalid response type 'file'. Allowed: base64, binary.
VALUE_OUT_OF_RANGE Numeric value outside allowed range PixelsPerModule (150) must be between 1 and 100.
MULTIPART_CONFIG_MISSING Multipart request missing config field Multipart request requires a 'config' field containing JSON configuration.

Authentication Errors (401)

Error CodeDescriptionExample
UNAUTHORIZED Authentication failed or missing Missing authentication header. Please use RapidAPI to access this API.
INVALID_API_KEY API key is invalid or expired Invalid authentication. Please use RapidAPI to access this API.
LLM_API_KEY_INVALID LLM provider API key is invalid (AI endpoint only) OpenAI API error: 401 - Invalid API key provided.

🤖 AI Generation Errors

These errors are specific to the AI-powered QR generation endpoint.

Error CodeHTTPDescriptionExample
INVALID_LLM_PROVIDER 400 Unsupported LLM provider specified Unsupported LLM provider 'chatgpt'. Supported providers: openai, anthropic, google, mistral, cohere, groq
INVALID_LLM_MODEL 400 Model not available for the selected provider Model 'gpt-6' is not available for OpenAI. Available models: gpt-5.2, gpt-4.1, gpt-4.1-mini, gpt-4.1-nano, o3, o3-mini, o4-mini
LLM_API_KEY_INVALID 401 The provided LLM API key is invalid OpenAI API error: 401 - Invalid API key provided.
AI_GENERATION_FAILED 500 AI failed to generate a valid configuration Failed to generate QR configuration from AI. Please check your API key and try again.
AI_CONFIG_INVALID 500 AI generated an invalid QR configuration AI generated an invalid configuration. Validation errors: Invalid color format...
AI_REQUEST_TIMEOUT 500 LLM API request timed out Request timed out. Please try again.

Server Errors (500)

Error CodeDescriptionExample
INTERNAL_ERROR Unexpected server error An unexpected error occurred while processing your request. Please try again later.
QR_GENERATION_FAILED QR code generation engine failed Failed to generate QR code. Please check your configuration and try again.

Error Response Examples

Missing Required Field

400 Bad RequestJSON
{
                "success": false,
                "error": {
                "code": "MISSING_REQUIRED_FIELD",
                "message": "The 'content' field is required and cannot be empty.",
                "field": "content"
  }
}

Invalid Color Format

400 Bad RequestJSON
{
                "success": false,
                "error": {
                "code": "INVALID_COLOR_FORMAT",
                "message": "Invalid color format for 'primaryColor': 'blue'. Use hex format (#RGB, #RRGGBB, or #RRGGBBAA).",
                "field": "primaryColor"
  }
}

Multiple Validation Errors

400 Bad RequestJSON
{
                "success": false,
                "error": {
                "code": "VALIDATION_ERROR",
                "message": "Validation failed with 3 errors.",
                "details": [
      {
                "field": "content",
                "code": "MISSING_REQUIRED_FIELD",
                "message": "The 'content' field is required and cannot be empty."
      },
      {
                "field": "primaryColor",
                "code": "INVALID_COLOR_FORMAT",
                "message": "Invalid color format for 'primaryColor': 'red'.",
                "value": "red"
      },
      {
                "field": "pixelsPerModule",
                "code": "VALUE_OUT_OF_RANGE",
                "message": "PixelsPerModule (200) must be between 1 and 100.",
                "value": 200
      }
    ]
  }
}

Invalid JSON

400 Bad RequestJSON
{
                "success": false,
                "error": {
                "code": "INVALID_JSON",
                "message": "Invalid JSON body: 'c' is an invalid start of a property name. Expected a '\"'. LineNumber: 2 | BytePositionInLine: 2."
  }
}

Authentication Error

401 UnauthorizedJSON
{
                "success": false,
                "error": {
                "code": "UNAUTHORIZED",
                "message": "Missing authentication header. Please use RapidAPI to access this API."
  }
}

Server Error

500 Internal Server ErrorJSON
{
                "success": false,
                "error": {
                "code": "QR_GENERATION_FAILED",
                "message": "Failed to generate QR code. Please check your configuration and try again."
  }
}
💡
Best Practice: Always check the success field first, then parse the error.code to programmatically handle specific error cases. The error.field property helps identify which input parameter caused the error.

Field Validation Constraints

FieldConstraints
contentRequired. Max 4,296 characters
eccLevelMust be: L, M, Q, H
pixelsPerModule1 - 100
fileFormatpng, jpg, jpeg, webp, svg, pdf
responseTypebase64, binary
outputWidth/Height0 - 4,096 pixels
backgroundOpacity0.0 - 1.0
Colors (all)Hex format: #RGB, #RRGGBB, #RRGGBBAA
foregroundStylesolid, linearGradient, radialGradient
gradientTypelinear, radial
gradientDirectionvertical, horizontal, diagonal, diagonal-reverse, radial, custom
qrShapesquare, circle, roundedsquare
moduleShapesquare, circle, roundedsquare, diamond, star, heart, hexagon, leaf, cross, dot, mosaic, clipped, clippedsmooth, pointed, pointedinward, pointedsmooth, pill, rounded, roundedinward, rounded-in, roundedpointed, rounded-pointed, circlestripe, circle-zebra, circlestripevertical, circle-zebra-vertical, japanese, octagon, shield, arrow, drop, vertical-line, horizontal-line, edgecut, teardrop, plus
modulePatternstandard, vertical-lines, horizontal-lines, diagonal-lines, dots-random, dots-gradient
moduleStylesolid, outline, dotted
moduleBlendModenormal, multiply, screen, overlay, darken, lighten, colorburn, colordodge, hardlight, softlight, difference, exclusion
finderOuterShapesquare, circle, roundedsquare, diamond, octagon, target, double
finderInnerShapesquare, circle, roundedsquare, diamond, star, dot
finderStylestandard, concentric-circles, target, logo
finderInnerPatternnone, cross, star, dot
finderBorderRadius0 - 50
finderInnerScale0.25 - 0.55
moduleScale0.5 - 1.0
logoShapesquare, circle
logoBackgroundnone, solid, blur
logoBorderWidth0 - 50
logoSizePercent3 - 40
logoPadding0+
frame.shaperectangle, speechbubble, badge, shield
frame.stylesolid, dashed, dotted, double
scanCorners.stylelines, brackets, dots
effects.edgeFadeTypesize, opacity, both
ctaPositionbottom, top
ctaFontSize1 - 200
frame.width0 - 100
frame.cornerRadius0 - 500
frame.padding0 - 200
frame.stylesolid, dashed, dotted, double
centerText.fontSize1 - 200
centerText.height1 - 500
centerText.orientationhorizontal, vertical-rotated, vertical-stacked
URLs (logo, background)Must start with http:// or https://. Max 2,048 characters
Logo file (multipart)Max 10 MB
WiFi ssidRequired. Max 32 characters
WiFi passwordRequired unless encryption is 'nopass'. Max 63 characters
WiFi encryptionWPA, WPA2, WPA3, WEP, nopass
Geo latitude-90 to 90
Geo longitude-180 to 180

Ready to Create Amazing QR Codes?

Start building with QR Branding API today. Full customization, enterprise reliability.

Get Started →