Public API documentation

Built for devs, queue, poll and generate on-demand.

The public generator and the backend stay aligned on the same request model. Start with render submission, poll the job, then retrieve the final SVG or PNG from the artifact endpoints.

Open generator Check live API status

POST

Queue a render job

/api/v1/qr/render

Submit the content route, visual styling, and output settings. The API returns a queued job with a status URL.

GET

Poll job status

/api/v1/qr/jobs/{jobId}

Retrieve the current status, resolved payload, timestamps, hashes, and any rendered SVG or PNG artifacts.

GET

Download artifacts

/api/v1/qr/jobs/{jobId}/artifacts/{format}

Fetch the persisted SVG or PNG output after the worker completes the render job.

Minimal render request

Start with a link QR, then add gradients, dotted data modules, or a centered logo when needed.

const response = await fetch("https://api.halfqr.com/api/v1/qr/render", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    contentType: "Link",
    targetUrl: "https://computemore.com",
    payload: {},
    errorCorrectionLevel: "H",
    output: { sizePx: 1024 },
    finder: { borderShape: "Rounded", centerShape: "Circle" },
    colors: { dark: "#10243C", light: "#FFFFFF" },
    data: {
      pattern: "Dotted",
      gradientMode: "Linear",
      gradientStart: "#F36D2C",
      gradientEnd: "#1F61C0",
      gradientRotation: 135
    }
  })
});