apyhub
Back
▣ INGESTION KIT · MEDIA KIT

Decode QR & Barcode File API

What it does

QR Code Reader extracts QR codes and barcodes from an uploaded image and returns the decoded results in a structured response. Send a file containing the image, and get the detected code data back for downstream processing.

Use it when users upload product labels, shipping parcels, tickets, receipts, or screenshots that contain machine-readable codes. The endpoint accepts one image file in the request body, with a maximum size of 24 megapixels, which keeps it suitable for mobile captures and scanned assets.

The response is an object with additional properties for the codes it finds. Because the payload is schema-light, it fits into workflows where you only need the decoded output and do not want to parse image content yourself. That makes QR Code Reader a good fit for inventory lookups, package tracking, check-in flows, and any app that needs to turn a camera image into usable code data.

POST
Read QR Codes and Barcodes
https://api.eu.apyhub.com/frolic/decode-qr-and-barcode-file

QUICKSTART

GUIDE

Quickstart

Upload one image that contains a QR code or barcode to read it.

curl -X POST "https://api.eu.apyhub.com/frolic/decode-qr-and-barcode-file" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/image.png"

What you'll get back

Returns a JSON object whose top-level fields are objects. The response schema does not define specific field names or inner properties, so the exact object keys depend on the API response.

{
  "result": {}
}
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body
Image with codes (max 24 megapixels)

About this endpoint

What it does

Uploads an image containing QR codes or barcodes and returns a JSON object on success. The response schema defines the output as an object with object-valued properties, but it does not yet specify the property names or their contents.

Request Body

ParameterTypeMandatoryDescription
fileStringYesImage with codes (max 24 megapixels). Binary upload.

Response

Returns a JSON object whose top-level properties are object values. The schema does not define any fixed response field names or the contents of those nested objects.

ParameterTypeMandatoryDescription

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.