Skip to main content
POST
/
api
/
display
/
locate
Locate Image on Screen
curl --request POST \
  --url http://localhost:4242/{computer_name}/api/display/locate \
  --header 'Content-Type: application/json' \
  --data '{
  "confidence": 0.9,
  "display_num": 1,
  "image_path": "/path/to/image.png"
}'
{
  "x": 100,
  "y": 100,
  "width": 50,
  "height": 50
}

Body

application/json

Image search parameters

​
image_path
string
required

Path to the image file to locate on screen

Example:

"/path/to/image.png"

​
confidence
number
default:0.9

Confidence threshold for image matching (0.0 to 1.0)

Required range: 0 <= x <= 1
Example:

0.9

​
display_num
integer
default:1

Display number to target

Example:

1

Response

Successfully searched for image

​
{key}
integer
⌘I