Orgo - Cloud computers for AI agents

POST

computers

{id}

mouse-move

Move mouse

curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/mouse-move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "x": 640,
  "y": 360
}
'

import requests

url = "https://www.orgo.ai/api/computers/{id}/mouse-move"

payload = {
    "x": 640,
    "y": 360
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({x: 640, y: 360})
};

fetch('https://www.orgo.ai/api/computers/{id}/mouse-move', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.orgo.ai/api/computers/{id}/mouse-move",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'x' => 640,
    'y' => 360
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.orgo.ai/api/computers/{id}/mouse-move"

	payload := strings.NewReader("{\n  \"x\": 640,\n  \"y\": 360\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.orgo.ai/api/computers/{id}/mouse-move")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"x\": 640,\n  \"y\": 360\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/computers/{id}/mouse-move")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"x\": 640,\n  \"y\": 360\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "action": "mouse_move",
  "details": {
    "x": 640,
    "y": 360
  },
  "error": null,
  "error_type": null
}

Moves the pointer to the given coordinates without pressing a button. Use it to hover: to open a menu that appears under the pointer, a tooltip, a link preview, or a toolbar that shows only on hover. Click and drag also move the pointer, but both press a button. To see what the hover opened, take a screenshot afterwards.

On a Windows computer the response is {"ok": true} and ?screen= is ignored. A coordinate above 100000 is refused with 400, and the error body reads Request failed with status code 400 rather than saying why.

This endpoint moves the pointer. To move a computer to another workspace, use Move computer.

Path parameters

string

required

Computer ID (UUID). An instance_id is not accepted here and fails with 500.

Query parameters

string

Which screen to move the pointer on. Optional. Omit it to act on the screen the computer booted with. Each screen has its own pointer, so the pointer on every other screen stays where it is. 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. 0 is the left edge.

integer

required

Y coordinate, in pixels from the top edge. 0 is the top edge.

Both coordinates are required and must be non-negative integers. A missing, negative, fractional, or non-numeric value, or a body that is not JSON, returns 400 before the computer is contacted. Any other field in the body is ignored.

Response

boolean

Always true on a 200. A failed move is an error status.

string

Always mouse_move.

object

Echo of the coordinates the pointer moved to: x and y.

null

Always null on a 200.

null

Always null on a 200.

Example

# Hover at (640, 360)
curl -X POST https://www.orgo.ai/api/computers/$COMPUTER_ID/mouse-move \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"x": 640, "y": 360}'

# Hover on a second screen
curl -X POST "https://www.orgo.ai/api/computers/$COMPUTER_ID/mouse-move?screen=screen-100" \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"x": 640, "y": 360}'

import os
import requests

response = requests.post(
    f"https://www.orgo.ai/api/computers/{os.environ['COMPUTER_ID']}/mouse-move",
    headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
    json={"x": 640, "y": 360},
)
print(response.json())

const response = await fetch(
  `https://www.orgo.ai/api/computers/${process.env.COMPUTER_ID}/mouse-move`,
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.ORGO_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ x: 640, y: 360 }),
  },
);
console.log(await response.json());

Response

{
  "success": true,
  "action": "mouse_move",
  "details": { "x": 640, "y": 360 },
  "error": null,
  "error_type": null
}

Errors

Status	Meaning
`400`	The computer has no VM attached: `{"error": "Desktop instance not available"}`. A body that is not JSON, or an `x` or `y` that is missing or is not a non-negative integer, returns `{"error": "x and y are required non-negative integers"}`.
`401`	Invalid API key: `{"error": "Invalid API key"}`. A request with no `Authorization` header returns `{"error": "Authentication required"}`. Access failures also return `401` on this endpoint, not `403`: `{"error": "You do not have access to this workspace."}` when you are neither the owner nor a member of the computer’s workspace, `{"error": "This workspace is view-only. Ask the owner for write access (workspace_read_only)."}` for a view-only member, and `{"error": "This API key cannot access this workspace (workspace_scope_mismatch)."}` for a workspace-scoped key used outside its workspace. A server-side fault while verifying the credential also returns `401`, with `{"error": "Service temporarily unavailable. The database is not accepting requests. Retry shortly."}`. Retry that one; the key is fine.
`402`	The computer was created as a free trial that is no longer active: `{"error": "Choose a plan to continue."}`. A computer paid for by its own subscription or dedicated purchase whose payment has lapsed returns `{"error": "Manage this computer’s payment in Account → Usage."}`.
`404`	No computer with this id: `{"error": "Desktop not found"}`. Also returned by the computer agent when `?screen=` names a screen this computer does not have, as in `{"error": "no screen \"screen-101\"", "request_id": "…", "upstream_status": 404}`.
`500`	The computer agent could not move the pointer, with its message in `error` and `upstream_status: 500`. Also returned when `id` is not a computer UUID.
`503`	The computer could not be reached: `{"error": "Could not reach the desktop. Try again in a moment.", "request_id": "…", "code": "ECONNREFUSED"}`. Safe to retry. Also returned when the computer never finished provisioning: `{"error": "Computer not ready", "request_id": "…"}`.

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.

{
  "error": "no screen \"screen-101\"",
  "request_id": "9f2b7c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "upstream_status": 404
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Computer ID

Query Parameters

screen

string

Which screen to move the pointer on. Omit for the boot screen. Each screen has its own pointer. An unknown id returns 404 rather than falling back.

Body

application/json

Where to move the pointer. Both coordinates are required non-negative integers; anything else returns 400. Any other field is ignored.

integer

required

X coordinate, in pixels from the left edge.

Required range: x >= 0

Example:

640

integer

required

Y coordinate, in pixels from the top edge.

Required range: x >= 0

Example:

360

Response

Pointer moved

success

boolean

Always true on a 200. A failed action is an error status.

Example:

true

action

string

The action performed: click, mouse_move, drag, type, key_press, scroll, or wait.

details

object

Echo of what was performed. Its fields depend on the action.

error

null

Always null on a 200.

error_type

null

Always null on a 200.

Move mouse

curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/mouse-move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "x": 640,
  "y": 360
}
'

import requests

url = "https://www.orgo.ai/api/computers/{id}/mouse-move"

payload = {
    "x": 640,
    "y": 360
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({x: 640, y: 360})
};

fetch('https://www.orgo.ai/api/computers/{id}/mouse-move', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.orgo.ai/api/computers/{id}/mouse-move",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'x' => 640,
    'y' => 360
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.orgo.ai/api/computers/{id}/mouse-move"

	payload := strings.NewReader("{\n  \"x\": 640,\n  \"y\": 360\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.orgo.ai/api/computers/{id}/mouse-move")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"x\": 640,\n  \"y\": 360\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/computers/{id}/mouse-move")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"x\": 640,\n  \"y\": 360\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "action": "mouse_move",
  "details": {
    "x": 640,
    "y": 360
  },
  "error": null,
  "error_type": null
}

Overview

Account

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Move mouse

Path parameters

Query parameters

Body parameters

Response

Example

Response

Errors

Authorizations

Path Parameters

Query Parameters

Body

Response

​Path parameters

​Query parameters

​Body parameters

​Response

​Example

​Response

​Errors

Authorizations

Path Parameters

Query Parameters

Body

Response

Path parameters

Query parameters

Body parameters

Response

Example

Response

Errors