Skip to content
Sandbox Agent
GitHub Get Started
HTTP API

Click on the desktop.

POST
/v1/desktop/mouse/click

Performs a health-gated pointer move and click against the managed desktop and returns the resulting mouse position.

Request Body required

Section titled “Request Body required ”
object
button
string
Allowed values: left middle right
clickCount
integer format: int32
nullable
x
required
integer format: int32
y
required
integer format: int32

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Desktop mouse position after click

object
screen
integer format: int32
nullable
window
string
nullable
x
required
integer format: int32
y
required
integer format: int32

400

Section titled “400 ”

Invalid mouse click request

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties

409

Section titled “409 ”

Desktop runtime is not ready

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties

502

Section titled “502 ”

Desktop runtime health or input failed

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties