QR Code Generation

The /qrcode endpoint generates a QR Code from a URL provided as a parameter. This endpoint is useful for quickly generating an image in PNG format.

GET/v3/qrcode

Parameters

Parameter	Required	Description
url	Yes	The URL to encode in the QR Code. Must contain the full address

Request Example

GET /v3/qrcode?url=https://docs.sylvain.sh

Response

{
    "qr": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIQAAACECAYAAABRRIOnAAAAAklEQVR4AewaftIAAAOaSURBVO3BQY5jBxYDwcwH3f/KnF7MgqsPCFKV7..."
}

Response Fields

Field	Description
qr	Base64-encoded PNG image of the QR Code

cURL

curl -X GET "https://api.sylvain.sh/v3/qrcode?url=https://docs.sylvain.sh"

Using the Response

The response contains a base64-encoded PNG image. You can use it directly in HTML:

<img src="data:image/png;base64,iVBORw0KGgo..." alt="QR Code" />

Or decode it and save as a file in your application.

Error Handling

If parameters are missing or invalid, the API will return an error:

Error Message	Description
Please provide a valid url (?url={URL})	The url parameter is missing or invalid