Skip to main content
POST
Moves the pointer to the given coordinates and clicks there.

Path parameters

string
required
Computer ID (UUID).

Query parameters

string
Which screen to click on. Optional. Omit it to act on the screen the computer booted with. An unknown id returns 404 rather than falling back to the default screen.

Body parameters

integer
required
X coordinate, in pixels from the left edge. Omitting it is not rejected. The click lands at 0.
integer
required
Y coordinate, in pixels from the top edge. Omitting it is not rejected. The click lands at 0.
string
default:"left"
Which button to press: left, right, or middle. Any other value falls back to left without an error.
boolean
default:"false"
Double-click instead of single-clicking. double always uses the left button, so button has no effect when it is set. The response still echoes the button you sent.
string[]
Keys held down for the duration of the click: 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.
integer
default:"1"
Number of clicks in rapid succession, so 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

boolean
Always true on a 200. A refused or failed click is an error status.
string
double_click when double was set, click otherwise.
object
Echo of what was performed. Always carries 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

Every failure raised after the request leaves the API layer also carries a request_id. Quote it in support requests. When the computer agent itself answered non-2xx, the body additionally carries upstream_status.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer ID

Query Parameters

screen
string

Which screen to act on. Omit for the boot screen. An unknown id returns 404 rather than falling back.

Body

application/json
x
integer
required

X coordinate

Required range: x >= 0
y
integer
required

Y coordinate

Required range: x >= 0
button
enum<string>
default:left

Which button to press. Any other value falls back to left without an error.

Available options:
left,
right,
middle
double
boolean
default:false

Double-click instead of single-clicking. A double-click always uses the left button, so button has no effect when this is set. The response still echoes the button you sent.

modifiers
enum<string>[]

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.

Required array length: 1 - 4 elements
Available options:
ctrl,
control,
alt,
option,
shift,
super,
cmd,
meta,
win
repeat
integer
default:1

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.

Required range: 1 <= x <= 10

Response

Click performed

success
boolean
Example:

true