POST
/api/v1/decode
Decode an image
POST /api/v1/decode reads a QR code out of an image you send as the request body. It returns the decoded text plus a classification (whether it is a link, a WiFi network, a payment, a contact card), so an agent can act on it without parsing the payload itself.
View as MarkdownPaste this page into any AI assistant. It is plain, portable Markdown.
Request
POST /api/v1/decode
Parameters
| Name | Type | Detail |
|---|---|---|
| bodyREQUIRED | string | The raw image bytes, with a matching Content-Type (image/png, image/jpeg, …). |
| url | string | Alternatively, a GET with an image URL to fetch. |
When you get it wrong
Errors are RFC 9457 problem+json with one addition: a fix field containing a corrected call you can run as-is.
{
"type": "https://useqr.app/errors",
"title": "No code found",
"status": 400,
"detail": "no QR code was detected in that image",
"fix": "crop closer to the code, or increase the contrast, then post it again"
}