Skip to main content

Retrieve a Link QR

Use the public Developer API to retrieve the standard safe QR for an existing Link in the workspace that owns your API key.

GET /api/v1/links/{id}/qr

id is the stable public Link ID. Internal database IDs are not accepted.

Default PNG​

A request with no query parameters returns a safe black-and-white PNG using the v1 default raster size target of 512 pixels.

QR modules are rendered as whole pixels, so the returned PNG may be slightly smaller than that target. X-Bytes-QR-Target-Pixels reports the target and X-Bytes-QR-Total-Pixels reports the actual returned width.

curl -L \
  -H "Authorization: Bearer $BYTES_API_KEY" \
  "https://api.jaww.ws/api/v1/links/01K0M4ZN8X7P9Q2R3S4T5V6W7X/qr" \
  --output link-qr.png

Standard QR retrieval is available on every Bytes plan. It does not expose Brand Kit treatment, centre logos, custom colours or print-production controls.

File formats​

Use format to choose the file type:

  • png, the default;
  • svg;
  • pdf.
GET /api/v1/links/{id}/qr?format=svg

The response uses the matching Content-Type and a truthful filename in Content-Disposition.

PNG size​

Use size to request a PNG raster size target in pixels:

GET /api/v1/links/{id}/qr?size=640

The accepted target range is 120 to 12000 pixels. Bytes still applies the existing QR renderer's module and scan-safety checks. The renderer keeps each QR module on a whole-pixel grid, so the actual returned width can be slightly below the requested target. A value inside the numeric range can also be rejected when it would make the QR unsafe.

For PNG responses, use X-Bytes-QR-Target-Pixels for the requested/default target and X-Bytes-QR-Total-Pixels for the actual returned width. The binary PNG dimensions remain authoritative.

size applies to PNG only. Supplying it with SVG or PDF returns 422 with:

{
  "message": "The size parameter applies to PNG output only.",
  "code": "parameter_not_applicable",
  "parameter": "size"
}

Deliberately small v1 contract​

Only format and size are supported query parameters. Undocumented presentation or production parameters are rejected rather than passed through to the QR renderer.

That prevents this endpoint from becoming a route around existing plan entitlements. In particular, v1 does not accept:

  • Brand Kit or custom appearance controls;
  • foreground or background colours;
  • centre logos;
  • intended medium or QR Output Profile selection;
  • physical size, scan distance or DPI;
  • RGB or CMYK selection;
  • ICC profiles.

Workspace isolation and lifecycle​

The API key workspace is authoritative. A Link from another workspace returns the same 404 shape as a missing Link, and archived or deleted Links are not retrievable through this endpoint.

The endpoint remains behind the standard Developer API authentication and throttling boundary.

Response metadata​

Where available, Bytes includes non-sensitive QR metadata in response headers, including the output profile, module count, safe appearance treatment, PNG raster size target and actual PNG pixel width.

The binary response itself remains the source of truth for the returned file.

Last updated on