Click mouse
Click at given screen coordinates, optionally with modifiers or a repeat count.
{"ok": true}. double uses the button you send rather than always the left one. An unrecognised button, a negative coordinate, or any modifiers or repeat field is refused with 400, and the error body reads Request failed with status code 400 rather than saying why. ?screen= is ignored.Path parameters
Query parameters
404 rather
than falling back to the default screen.Body parameters
0.0.left, right, or middle. Any other value falls
back to left without an error.double always uses the left button,
so button has no effect when it is set. The response still echoes the
button you sent.shift to extend a selection,
ctrl to add to one. Optional; omit for a plain click. One to four of ctrl
(alias control), alt (alias option), shift, and super (aliases
cmd, meta, win). An unrecognised name rejects the whole request rather
than dropping one modifier and performing a different gesture. Cannot be
combined with double or with repeat above 1.3 is a triple-click. Optional;
1 through 10. Values of 1 or below behave as a single click. The repeat is
counted on the computer, so the gap between presses stays under the toolkit’s
multi-click threshold no matter how slow the network is. Cannot be combined
with modifiers.Response
x, y, and button. A plain
click adds double: false; a repeat click adds repeat; a modified click
adds modifiers with the names normalised (option comes back as alt).Example
Response
Errors
request_id. Quote it in support requests. When the computer agent itself
answered non-2xx, the body additionally carries upstream_status.
Authorizations
Query Parameters
Body
Keys held down for the duration of the click. Use shift to extend a selection, ctrl to add to one. Optional: omit for a plain click. One to four of ctrl (alias control), alt (alias option), shift, and super (aliases cmd, meta, win). An unrecognised name rejects the whole request rather than dropping one modifier and performing a different gesture. Cannot be combined with double or with repeat above 1. The response echoes the names normalised, so option comes back as alt.
1 - 4 elementsctrl, control, alt, option, shift, super, cmd, meta, win Number of clicks in rapid succession, so 3 is a triple-click. Optional. Values of 1 or below behave as a single click, and a value above 10 is refused with 400. The repeat is counted on the computer, so the gap between presses stays under the toolkit's multi-click threshold no matter how slow the network is. Cannot be combined with modifiers.
1 <= x <= 10Response
Click performed