Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: v1
title: barcodeapi Barcode Scan API
description: Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
servers:
- url: http://localhost
tags:
- name: BarcodeScan
paths:
/barcode/scan/image:
post:
tags:
- BarcodeScan
summary: Scan and recognize an image of a barcode
description: Scan an image or photo of a barcode and return the result. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB
operationId: BarcodeScan_Image
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BarcodeScanResult'
text/json:
schema:
$ref: '#/components/schemas/BarcodeScanResult'
application/xml:
schema:
$ref: '#/components/schemas/BarcodeScanResult'
text/xml:
schema:
$ref: '#/components/schemas/BarcodeScanResult'
security:
- Apikey: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
imageFile:
type: string
description: Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
format: binary
required:
- imageFile
/barcode/scan/image/advanced:
post:
tags:
- BarcodeScan
summary: Advanced AI scan and recognition of an image of one or more barcodes of any type
description: Scan an image or photo of a barcode and return the result with enhanced accuracy, particularlly for low quality inputs using Advanced AI. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB. Uses large model AI. Consumes 100 API calls per image page. For Managed Instance and Private Cloud requires GPU infrastructure. Supports PNG, PDF and JPEG input file formats.
operationId: BarcodeScan_ImageAdvanced
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BarcodeAdvancedScanResult'
text/json:
schema:
$ref: '#/components/schemas/BarcodeAdvancedScanResult'
application/xml:
schema:
$ref: '#/components/schemas/BarcodeAdvancedScanResult'
text/xml:
schema:
$ref: '#/components/schemas/BarcodeAdvancedScanResult'
security:
- Apikey: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
imageFile:
type: string
description: Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
format: binary
required:
- imageFile
/barcode/scan/image/advanced/qr:
post:
tags:
- BarcodeScan
summary: Advanced AI scan and recognition of an image of one or more QR barcodes
description: Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.
operationId: BarcodeScan_ImageAdvancedQR
parameters:
- name: preprocessing
in: header
description: Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), SmoothEdges, SmoothEdgesPlus, and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement. Set to SmoothEdges to smooth harsh edges in the input image to enhance recognition accuracy. Set to SmoothEdgesPlus to smooth harsh edges to a higher degree.
required: false
schema:
type: string
- name: recognitionMode
in: header
description: Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BarcodeScanQRAdvancedResult'
text/json:
schema:
$ref: '#/components/schemas/BarcodeScanQRAdvancedResult'
application/xml:
schema:
$ref: '#/components/schemas/BarcodeScanQRAdvancedResult'
text/xml:
schema:
$ref: '#/components/schemas/BarcodeScanQRAdvancedResult'
security:
- Apikey: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
imageFile:
type: string
description: Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
format: binary
required:
- imageFile
components:
schemas:
BarcodeAdvancedScanResult:
description: Result of the advanced barcode scan
type: object
properties:
Successful:
description: True if the operation was successful, false otherwise
type: boolean
ResultBarcodes:
description: Results of performing the barcode scan operation
type: array
items:
$ref: '#/components/schemas/BarcodeAdvancedResultItem'
BarcodeCount:
format: int32
description: Number of barcodes read
type: integer
ErrorMessage:
description: Error message if any
type: string
BarcodeScanQRAdvancedResult:
description: Result of the advanced QR barcode scan
type: object
properties:
Successful:
description: True if the operation was successful, false otherwise
type: boolean
ResultBarcodes:
description: Results of performing the QR barcode scan operation
type: array
items:
$ref: '#/components/schemas/BarcodeQRResultItem'
BarcodeCount:
format: int32
description: Number of barcodes read
type: integer
ErrorMessage:
description: Error message if any
type: string
BarcodeQRResultItem:
description: QR barcode instance
type: object
properties:
RawText:
description: The barcode text
type: string
BarcodeScanResult:
description: Result of the barcode scan
type: object
properties:
Successful:
description: True if the operation was successful, false otherwise
type: boolean
BarcodeType:
description: The type of the barcode; possible values are AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB
type: string
RawText:
description: The barcode text
type: string
BarcodeAdvancedResultItem:
description: Advanced barcode scan result instance
type: object
properties:
RawText:
description: The barcode text
type: string
BarcodeType:
description: Type of the barcode; supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB.
type: string
securitySchemes:
Apikey:
type: apiKey
description: API Key Authentication
name: Apikey
in: header
x-provenance:
method: harvested
publisher: Cloudmersive
source: https://api.cloudmersive.com/barcode/docs/v1/swagger
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)