QRcodly
APIQr code

Render a QR code to an image buffer

POST
/qr-code/render

Returns a fully rendered QR code in PNG, WebP, JPEG or SVG. Supports ETag-based caching. Intended for third-party clients (design plugins) that cannot render complex QR-styling output themselves.

Authorization

bearerAuth
AuthorizationBearer <token>

Authenticate with a Bearer token. Pass your API key in the Authorization header: Authorization: Bearer <your-api-key>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/qr-code/render" \  -H "Content-Type: application/json" \  -d '{    "config": {      "width": 0,      "height": 0,      "margin": 0,      "imageOptions": {        "hideBackgroundDots": true      },      "dotsOptions": {        "type": "dots",        "style": {          "type": "hex",          "value": "string"        }      },      "cornersSquareOptions": {        "type": "dot",        "style": {          "type": "hex",          "value": "string"        }      },      "cornersDotOptions": {        "type": "dot",        "style": {          "type": "hex",          "value": "string"        }      },      "backgroundOptions": {        "style": {          "type": "hex",          "value": "string"        }      }    },    "data": "string"  }'
Empty