POST /v1/codes/qr-logo

QR code with a logo

Your mark centred in the code, with the error correction raised automatically to cover what it hides.

Put a logo in a QR code now No key, no code — 2 credits either way.

curl -X POST "$DOATHING_API/v1/codes/qr-logo" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"text": "https://doathing.com", "file": {"filename": "logo.png", "content_type": "image/png", "data_b64": "<base64>"}, "options": {"logo_percent": 18}}'

Your mark centred in the code, with the error correction raised automatically to cover what it hides.

Embed a logo image at the centre of a QR code, raising error correction to compensate for the occlusion.

Input

Send a file object with base64 data_b64, its content_type and a filename. Accepted types: image/png, image/jpeg, image/webp, image/gif, image/tiff.

The declared type is not trusted — the bytes are sniffed and a contradiction is rejected rather than corrected.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "version": 4,
  "error_correction": "H",
  "logo_percent": 18,
  "logo_pixels": {
    "width": 132,
    "height": 132
  },
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

2 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.

Parameters

Generated from the endpoint’s own validation, so this is exactly what it accepts. A body field goes at the top level; an option goes inside options.

NameInTypeDefaultNotes
text *bodystring
logo_backgroundoptionsbooleantruePut a quiet patch behind the logo so the decoder sees a clean boundary.
logo_percentoptionsinteger20Share of the code's area the logo covers, up to 30. 5 to 100
scaleoptionsinteger12Pixels per module. 6 to 40
borderoptionsinteger40 to 20
darkoptionsstring"#000000"
lightoptionsstring"#FFFFFF"