SKQR Forge API Docs

Anonymous free key

Anyone can test the render API without creating an account using the anonymous key below. The anonymous key gives 20 render requests per anonymous identity per week.

skqr_anon/-/free-weekly-20\-\

"tok-kw">curl "tok-prop">-X "tok-kw">POST https://skqr.smrprprp.xyz/api/v1/render \
  "tok-prop">-H "">Content-Type: application/json" \
  "tok-prop">-H "X-API-Key: skqr_anon/-/free-weekly-20\-\" \
  "tok-prop">-H "X-SKQR-Anonymous-Id: my-shortcut">-device-001" \
  "tok-prop">-d '{
    "data": "https://smbeta.xyz",
    "title": "smbeta.xyz",
    "moduleShape": "rounded",
    "accent": "#ff2b2b"
  }' \
  --"tok-kw">output skqr-render.zip

Authentication model

SKQR uses two token types. They are not the same and should not be mixed.

X-API-Key: skqr/-/xxxxxxxxxxxxxxx\-\
# or
Authorization: Bearer skqr/-/xxxxxxxxxxxxxxx\-\

Authorization: Bearer FIREBASE_ID_TOKEN

How to get a Firebase ID token

The Firebase ID token is created by Firebase Auth when a user signs in. In the SKQR website, users can reveal it from Account → API Key Section → Firebase ID Token. To reveal it, SKQR sends a verification code by email. After the code is verified, the token is shown and can be copied.

"tok-kw">import { getAuth, signInWithEmailAndPassword } "tok-kw">from 'firebase/auth';

"tok-kw">const auth = getAuth();
"tok-kw">await signInWithEmailAndPassword(auth, email, password);
"tok-kw">const firebaseIdToken = "tok-kw">await auth.currentUser.getIdToken(true);

"tok-kw">curl "tok-prop">-X "tok-kw">POST https://skqr.smrprprp.xyz/api/issues/comment \
  "tok-prop">-H "">Authorization: ">Bearer FIREBASE_ID_TOKEN" \
  "tok-prop">-H "">Content-Type: application/json" \
  "tok-prop">-d '{
    "issueId": "LOCAL_ISSUE_ID",
    "message": "Reply sent from iOS Shortcuts."
  }'

POST /api/v1/render

Renders a QR code from a schema and returns a downloadable ZIP package. On success, the response is a file download, not JSON.

{
  "data": "https://smbeta.xyz",
  "title": "smbeta.xyz",
  "subtitle": "CONNECT > BUILD > DEPLOY > REPEAT",
  "accent": "#ff2b2b",
  "dark": "#ffffff",
  "light": "#030000",
  "frame": true,
  "moduleShape": "rounded",
  "outlineWidth": 0
}

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Disposition: attachment; filename="skqr-smbeta-xyz.zip"

ZIP folder:
  qr.svg
  qr.png
  qr.webp
  panel.svg
  panel.png
  panel.webp
  schema.json
  README.txt

Complete API parameter reference

This is the only full parameter-table section. It lists the public headers/body values developers need to use SKQR APIs without mixing them with normal status-code or error examples.

Issues API

Issues can be submitted publicly from the website. Signed-in users can track, read, and reply to their own issues with a Firebase ID token. Anonymous users cannot receive status updates unless they create an account.

"tok-kw">curl "tok-prop">-X "tok-kw">POST https://skqr.smrprprp.xyz/api/issues/create \
  "tok-prop">-H "">Authorization: ">Bearer FIREBASE_ID_TOKEN" \
  "tok-prop">-H "">Content-Type: application/json" \
  "tok-prop">-d '{
    "title": "Render API issue",
    "category": "api",
    "message": "The ZIP render looks wrong in my shortcut."
  }'

"tok-kw">curl "tok-prop">-X "tok-kw">POST https://skqr.smrprprp.xyz/api/issues/create \
  "tok-prop">-H "">Content-Type: application/json" \
  "tok-prop">-d '{
    "title": "Anonymous report",
    "category": "bug",
    "message": "Something is not working.",
    "anonymousAccepted": true
  }'

"tok-kw">curl "tok-prop">-X "tok-kw">POST https://skqr.smrprprp.xyz/api/issues/comment \
  "tok-prop">-H "">Authorization: ">Bearer FIREBASE_ID_TOKEN" \
  "tok-prop">-H "">Content-Type: application/json" \
  "tok-prop">-d '{
    "issueId": "LOCAL_ISSUE_ID",
    "message": "Here is more information."
  }'

QR schema fields

QR schemas are saved as recipes, not rendered images. This keeps accounts lightweight and lets users regenerate QR codes later.

{
  "data": "https://smbeta.xyz",
  "title": "smbeta.xyz",
  "subtitle": "CONNECT > BUILD > DEPLOY > REPEAT",
  "width": 720,
  "height": 720,
  "margin": 28,
  "qrColor": "#ffffff",
  "bgColor": "#030000",
  "accent": "#ff2b2b",
  "moduleShape": "rounded",
  "moduleGap": 0.08,
  "transparentQR": false,
  "frame": true,
  "glass": true,
  "relief": true,
  "glow": true,
  "logoUrl": "https://example.com/logo.png"
}

Errors

Error responses are JSON. Success responses from /api/v1/render are ZIP downloads.

{
  "error": "Invalid API key."
}

• 400 — missing or invalid request body.
• 401 — missing, invalid, or revoked auth token/API key.
• 403 — 2FA, Developer mode, account owner, or team access required.
• 429 — anonymous weekly quota exceeded.
• 500 — server configuration or provider error.

Developer workflows

1. Fast test: use the anonymous free key for up to 20 render requests per week per anonymous identity.
2. Full developer access: create an account, activate 2FA, enable Developer mode, then generate a SKQR API key.
3. Account automation: reveal your Firebase ID token from Account after email verification, then use it for My Issues/account endpoints.

"tok-kw">const response = "tok-kw">await "tok-kw">fetch('https://skqr.smrprprp.xyz/api/v1/render', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'skqr/-/xxxxxxxxxxxxxxx\-\'
  },
  body: JSON.stringify({
    data: 'https://smbeta.xyz',
    title: 'smbeta.xyz',
    moduleShape: 'diamond'
  })
});

if (!response.ok) throw new Error(await response.text());
const zipBlob = await response.blob();
const url = URL.createObjectURL(zipBlob);
const a = document.createElement('a');
a.href = url;
a.download = 'skqr-render.zip';
a.click();