Desktop ›
Click desktop
POST
/v1/sandboxes/{id}/desktop/clickMoves the pointer to a point of the sandbox's screen and presses a button there: once, or with count 2 or 3 as a double or a triple click.
RequestTypeScript
- import { Agental } from "agental-sdk";
- const agental = new Agental();
- const sandbox = await agental.sandboxes.get("sbx_2a9a47e50daec64a");
- await sandbox.desktop.click(640, 360);
Answer204 No Content
No body: the status says it was done.
Done.
Path
idrequiredstring | e.g. "sbx_0123456789abcdef" |
Headers
AuthorizationrequiredBearer key | An API key that may make this call. |
Body
xrequiredinteger | Pixels from the left edge of the screen. e.g. 640 |
yrequiredinteger | Pixels from the top edge of the screen. e.g. 400 |
button"left" | "middle" | "right" | Which button. left when it is not given. |
countinteger | How many times the button is pressed. 1 when it is not given. |
Returns
204 Done. There is nothing to say back: GET /v1/sandboxes/{id}/desktop/screenshot shows what came of it.
Errors and other answers
| 400 | invalid_request a field is missing or is not what it has to be, or a point is not on the screen. The message says which. |
| 404 | Not found. |
| 409 | sandbox_not_running, or |
| 409 | desktop_not_running no desktop is turned on for the sandbox, or it is turned on and is not running yet, as in the moments after a start. PUT /v1/sandboxes/{id}/desktop turns it on, and starts one that ended. |
| 501 | desktop_not_configured sandboxes here have no desktop. GET /v1/policy says so as desktop. |
Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.