{"openapi":"3.1.0","info":{"title":"Snip API","version":"1.0.0","description":"Free short links and QR codes you can edit after printing, with click and scan analytics by day, country, referrer and device."},"servers":[{"url":"https://snip.link","description":"Production"}],"tags":[{"name":"Tools","description":"What the product does. Each call is metered in credits."},{"name":"Account","description":"Inspect the calling key and its usage. Free to call."}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authorization: Bearer snip_live_..."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","description":"The same key in the X-API-Key header, for clients that cannot set Authorization."}},"schemas":{"QrCodeResponse":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/QrCodeResult"},"meta":{"$ref":"#/components/schemas/RunMeta"}},"required":["result","meta"],"example":{"result":{"svg":"","version":3,"modules":29,"ecc":"M","bytes":34,"contrast":18.88,"warning":null},"meta":{"tool":"qr_code","credits_charged":1,"balance":4212,"size":34,"cache":"off","latency_ms":9,"request_id":"7f0c2a2b-4bb0-4a8b-9d0e-2b2a7e0f1c3d"}}},"QrCodeResult":{"type":"object","properties":{"svg":{"type":"string","description":"The code as a standalone SVG document, ready to save or inline."},"version":{"type":"integer","description":"QR version, 1 to 40: the smallest that fits the data."},"modules":{"type":"integer","description":"Modules per side, without the quiet zone."},"ecc":{"type":"string","enum":["L","M","Q","H"],"description":"The error correction level used."},"bytes":{"type":"integer","description":"UTF-8 length of the data."},"contrast":{"type":"number","description":"WCAG contrast ratio between fg and bg, 1 to 21."},"warning":{"type":["string","null"],"enum":["lowContrast","inverted",null],"description":"lowContrast: under 4.5 to 1, phones may not read it. inverted: light on dark, some scanners fail. null: fine."}},"required":["svg","version","modules","ecc","bytes","contrast","warning"]},"RunMeta":{"type":"object","properties":{"tool":{"type":"string"},"credits_charged":{"type":"integer"},"balance":{"type":"integer","description":"Credits left on the account after this call."},"size":{"type":"integer","description":"Input size in the tool's unit (see the tool's description)."},"cache":{"type":"string","enum":["hit","miss","off"]},"latency_ms":{"type":"integer"},"request_id":{"type":"string"}},"required":["tool","credits_charged","balance","size","cache","latency_ms","request_id"]},"Error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","invalid_api_key","insufficient_credits","forbidden","not_found","rate_limited","quota_exceeded","input_too_large","upstream_failed","timeout","internal_error"],"description":"Stable machine-readable code."},"message":{"type":"string","description":"Human-readable explanation."},"request_id":{"type":"string","description":"Echoed in the X-Request-Id header. Quote it in support requests."},"details":{"description":"Field-level validation details, or the size and limit behind input_too_large."}},"required":["code","message","request_id"],"example":{"code":"insufficient_credits","message":"Your balance is 0 credits and this run costs 1.","request_id":"b9d4d1a2-6a4e-4f1e-9d0a-1d2f3e4c5b6a"}},"QrCodeInput":{"type":"object","properties":{"data":{"type":"string","minLength":1,"maxLength":2953,"description":"What the code holds: a link, plain text, or a Wi-Fi, vCard, mailto: or tel: payload. 1 to 2,953 bytes of UTF-8; the most it can hold drops at higher error correction. Size limits are counted in characters and depend on your plan.","example":"https://snip.link/spring-menu?qr=1"},"style":{"type":"string","enum":["rounded","square"],"description":"Module shape: rounded dots with rounded finder rings, or classic squares. Default rounded."},"fg":{"type":"string","description":"Dark module colour as #rrggbb. Default #111111.","example":"#111111"},"bg":{"type":"string","description":"Background colour as #rrggbb. Default #ffffff.","example":"#ffffff"},"ecc":{"type":"string","enum":["L","M","Q","H"],"description":"Error correction: L 7%, M 15%, Q 25%, H 30% of the code can be damaged and still scan. Default M."},"margin":{"type":"integer","minimum":0,"maximum":16,"description":"Quiet zone around the code, in modules. The standard asks for 4. Default 4."},"size":{"type":"integer","minimum":64,"maximum":4096,"description":"Width and height attributes of the SVG, in pixels. The drawing is vector and scales without loss. Default 1024."}},"required":["data"]},"UsageResponse":{"type":"object","properties":{"period":{"type":"object","properties":{"start":{"type":"string","description":"ISO 8601 start of the current UTC month."},"end":{"type":"string","description":"ISO 8601 start of the next UTC month."}},"required":["start","end"]},"plan":{"type":"string"},"balance":{"type":"integer","description":"Credits available right now, across all keys."},"granted_this_period":{"type":"integer"},"usage":{"type":"object","properties":{"requests":{"type":"integer"},"credits":{"type":"integer"},"cache_hits":{"type":"integer"},"errors":{"type":"integer"}},"required":["requests","credits","cache_hits","errors"]},"key":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"requests":{"type":"integer","description":"Requests this period on the calling key."},"rps":{"type":"integer"}},"required":["id","name","requests","rps"]}},"required":["period","plan","balance","granted_this_period","usage","key"],"example":{"period":{"start":"2026-09-01T00:00:00.000Z","end":"2026-10-01T00:00:00.000Z"},"plan":"pro","balance":4213,"granted_this_period":10000,"usage":{"requests":612,"credits":612,"cache_hits":0,"errors":3},"key":{"id":"b0a1c2d3-1111-4222-8333-444455556666","name":"production","requests":1502,"rps":10}}},"MeResponse":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string","description":"First characters of the key, for identification."},"rps":{"type":"integer"},"created_at":{"type":"string"},"last_used_at":{"type":["string","null"]}},"required":["id","name","prefix","rps","created_at","last_used_at"]},"plan":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"monthly_credits":{"type":"integer"}},"required":["id","name","monthly_credits"]},"tools":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"pricing":{"type":"string"},"max_input":{"type":"integer"},"unit":{"type":"string"}},"required":["id","pricing","max_input","unit"]},"description":"Every tool with its price and this plan's input limit."}},"required":["key","plan","tools"],"example":{"key":{"id":"b0a1c2d3-1111-4222-8333-444455556666","name":"production","prefix":"snip_live_4Qm7","rps":10,"created_at":"2026-08-30T18:04:11.000Z","last_used_at":"2026-09-08T09:12:40.000Z"},"plan":{"id":"pro","name":"Pro","monthly_credits":10000},"tools":[{"id":"qr_code","pricing":"1 credit per code","max_input":3000,"unit":"characters"}]}}},"parameters":{}},"paths":{"/v1/qr_code":{"post":{"operationId":"qr_code","summary":"A scannable QR code as SVG for a link or text, in your style and colours.","description":"Encodes a link or text as a static QR code and returns it as a standalone SVG. Picks the smallest version that fits, draws rounded or square modules in your colours, sets the error correction level and quiet zone, and reports the contrast between the colours with a warning when phones may struggle to scan it. Costs 1 credit per code. Input size is counted in characters; the per-run limit depends on the plan. Also available as the MCP tool `snip_qr_code`.","tags":["Tools"],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"data":"https://snip.link/spring-menu?qr=1"},"schema":{"$ref":"#/components/schemas/QrCodeInput"}}}},"responses":{"200":{"description":"The result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QrCodeResponse"}}}},"400":{"description":"The body is missing or invalid. `details` names each field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing, malformed or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The account has too few credits for this run. Buy a top-up or upgrade the plan.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"The input is larger than the plan allows per run. `details` carries the size, the limit and the unit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The key exceeded its requests-per-second limit. Honor the Retry-After header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream the tool depends on failed. The credits were refunded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"The run took longer than the tool's time limit. The credits were refunded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/usage":{"get":{"operationId":"usage","summary":"Current period usage","description":"Balance and usage for the current UTC month, plus the calling key's own request count. Free to call.","tags":["Account"],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Usage summary.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}},"401":{"description":"The API key is missing, malformed or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me":{"get":{"operationId":"me","summary":"Key metadata","description":"Describes the calling key and its plan. Useful for verifying a key before shipping it in a deployment. Free to call.","tags":["Account"],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Key metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeResponse"}}}},"401":{"description":"The API key is missing, malformed or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{}}