Skip to main content
POST
Detect Screenshot
Detect icons and UI elements and read the text in a screenshot you supply. Send the image as base64 PNG or JPEG. inference_type chooses icons (detect), text (ocr), or both (combined), and ocr_engine chooses the free or premium text engine. Detection is billed per page through the Axilio model line. See Models for the tiers and prices. To find one described element instead of every element, use Screenshots: locate. You can pass the text this operation returns as that request’s texts. Errors use the problem details shape.

Authorizations

X-Axilio-Api-Key
string
header
required

Axilio API key (axl_*).

Body

application/json
image
string
required

Base64 encoded image data

Maximum string length: 16777216
confidence_threshold
number
default:0.25

Minimum confidence threshold for detections and OCR results

Required range: 0 <= x <= 1
inference_type
enum<string>
default:combined

Type of inference to perform

Available options:
detect,
ocr,
combined
nms_iou_threshold
number
default:0.45

IoU threshold for Non-Maximum Suppression (NMS)

Required range: 0 <= x <= 1
ocr_engine
string
default:free

OCR engine to use: 'free' or 'premium'

Response

Successful Response

data
InferenceData · object
required

Inference results data

analyzer_type
string
default:all

Analyzer type used

type
string
default:analyzer_result

Response type