Skip to content

Read Text (OCR) Node

Automation/Computer/Vision

Recognizes text in an image or on the screen with the operating system's OCR engine (Apple Vision, Windows OCR, Tesseract on Linux). Lines carry pixel boxes and, when the screen frame is known, desktop coordinates for the mouse nodes

computer_ocrautomationLocal only
Inputs13
Outputs5
Security exposure5/10
Packageautomation

Ratings

Scores range from 0 to 10. Higher values mean more impact, exposure, or operational weight.

SecurityAttack surface and exposure impact.
5/10Medium
PrivacyPotential sensitivity of processed data.
4/10Medium
PerformanceRuntime or resource pressure.
6/10Medium
GovernancePolicy, audit, or compliance impact.
6/10Medium
ReliabilityOperational stability considerations.
7/10High
CostExternal or compute cost impact.
10/10High

Input Pins

13

▶

Execution
exec_in

Trigger

Session

Struct
session

Computer session handle

AutomationSessionAutomationSession11 fields
session_refstringrequired
platformPlatformrequired
enum "Windows", "MacOS", "Linux"
default_delay_msinteger:uint64required
format uint64min 0
click_delay_msinteger:uint64required
format uint64min 0
debug_modebooleanrequired
browser_typeanyOf (2)

Browser context info if browser is attached

variant 1BrowserTypevariant
enum "Chrome", "Firefox", "Edge", "Safari"
variant 2nullvariant
browser_headlessboolean | null
browser_user_data_dirstring | null
current_page_refstring | null

Current page info if a page is open

current_window_handlestring | null
browser_frame_selectorsArray<Selector>
default []
itemsSelectorarray item
kindSelectorKindrequired
variant 1enumvariant
enum "Css", "Xpath", "TextExact", "TestId"...
variant 2constvariant

Visible text contained in the element; script, style and head content is ignored.

const "Text"
variant 3constvariant

ARIA role, optionally filtered by accessible name: `button`, `button|Sign in` (case-insensitive substring), `button|=Sign in` (exact) or `button|/^sign/i` (regex).

const "Role"
variant 4constvariant

Element ref from the latest Browser Snapshot, such as `e12`.

const "Ref"
valuestringrequired
confidencenumber | null
format double
scopestring | null

Image

Struct
image

Image to read; leave unconnected to capture the window, region or display below

NodeImageNodeImage1 fields
image_refstringrequired

Frame

Struct
image_frame

Screen frame of the connected image; maps recognized boxes to desktop coordinates

ScreenFrameScreenFrame7 fields
display_indexinteger | null
format uint32default nullmin 0
xinteger:int32required
format int32
yinteger:int32required
format int32
widthinteger:uint32required
format uint32min 0
heightinteger:uint32required
format uint32min 0
pixel_widthinteger:uint32required
format uint32min 0
pixel_heightinteger:uint32required
format uint32min 0

Window Title

String
window_title

Look only inside the window with this title; empty uses the region or display

Display Index

Integer
display_index

Display to capture when no window or region is given

Default 0

Region X

Integer
region_x

Left edge of the region in desktop input coordinates

Default 0

Region Y

Integer
region_y

Top edge of the region in desktop input coordinates

Default 0

Region Width

Integer
region_width

Region width; 0 captures the whole display

Default 0

Region Height

Integer
region_height

Region height; 0 captures the whole display

Default 0

Languages

String
languages

Comma-separated languages such as en-US, de; empty lets the OS engine choose

Language Correction

Boolean
language_correction

Let the engine correct words with its language model (Apple Vision); turn off for codes and identifiers

Default true

Min Confidence

Float
min_confidence

Drop lines below this confidence (0–1); engines without confidence keep all lines

Default 0
Range 0 to 1Step 0.05

Output Pins

5

▶

Execution
exec_out

Continue

Session

Struct
session_out

Computer session handle (pass-through)

AutomationSessionAutomationSession11 fields
session_refstringrequired
platformPlatformrequired
enum "Windows", "MacOS", "Linux"
default_delay_msinteger:uint64required
format uint64min 0
click_delay_msinteger:uint64required
format uint64min 0
debug_modebooleanrequired
browser_typeanyOf (2)

Browser context info if browser is attached

variant 1BrowserTypevariant
enum "Chrome", "Firefox", "Edge", "Safari"
variant 2nullvariant
browser_headlessboolean | null
browser_user_data_dirstring | null
current_page_refstring | null

Current page info if a page is open

current_window_handlestring | null
browser_frame_selectorsArray<Selector>
default []
itemsSelectorarray item
kindSelectorKindrequired
variant 1enumvariant
enum "Css", "Xpath", "TextExact", "TestId"...
variant 2constvariant

Visible text contained in the element; script, style and head content is ignored.

const "Text"
variant 3constvariant

ARIA role, optionally filtered by accessible name: `button`, `button|Sign in` (case-insensitive substring), `button|=Sign in` (exact) or `button|/^sign/i` (regex).

const "Role"
variant 4constvariant

Element ref from the latest Browser Snapshot, such as `e12`.

const "Ref"
valuestringrequired
confidencenumber | null
format double
scopestring | null

Text

String
text

All recognized lines in reading order, separated by newlines

Lines

Struct Array
lines

Recognized lines with confidence, pixel boxes, desktop boxes and word boxes

OcrLineOcrLine6 fields
textstringrequired
confidencenumber | null
format doubledefault null
bbox_pxPixelBoxrequired

A rectangle in image pixels, origin top-left.

xinteger:uint32required
format uint32min 0
yinteger:uint32required
format uint32min 0
widthinteger:uint32required
format uint32min 0
heightinteger:uint32required
format uint32min 0
bboxanyOf (2)
default null
variant 1InputRectvariant

A rectangle in desktop input coordinates, the space the mouse nodes use.

xinteger:int32required
format int32
yinteger:int32required
format int32
widthinteger:uint32required
format uint32min 0
heightinteger:uint32required
format uint32min 0
variant 2nullvariant
centeranyOf (2)
default null
variant 1InputPointvariant
xinteger:int32required
format int32
yinteger:int32required
format int32
variant 2nullvariant
wordsArray<OcrWord>
default []
itemsOcrWordarray item

One recognized word. `bbox` is filled when the image's screen frame is known.

textstringrequired
confidencenumber | null

0–1; absent when the engine does not report confidence (Windows).

format doubledefault null
bbox_pxPixelBoxrequired

A rectangle in image pixels, origin top-left.

xinteger:uint32required
format uint32min 0
yinteger:uint32required
format uint32min 0
widthinteger:uint32required
format uint32min 0
heightinteger:uint32required
format uint32min 0
bboxanyOf (2)
default null
variant 1InputRectvariant

A rectangle in desktop input coordinates, the space the mouse nodes use.

variant 2nullvariant

Frame

Struct
frame

Screen frame of the recognized image; empty when an image without frame was read

ScreenFrameScreenFrame7 fields
display_indexinteger | null
format uint32default nullmin 0
xinteger:int32required
format int32
yinteger:int32required
format int32
widthinteger:uint32required
format uint32min 0
heightinteger:uint32required
format uint32min 0
pixel_widthinteger:uint32required
format uint32min 0
pixel_heightinteger:uint32required
format uint32min 0

Node Info

Internal name
computer_ocr
Category
Automation/Computer/Vision
Version
1