Orgo - Cloud computers for AI agents

POST

computers

{id}

scroll

Scroll

curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/scroll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "x": 640,
  "y": 400,
  "direction": "down",
  "amount": 3
}
'

import requests

url = "https://www.orgo.ai/api/computers/{id}/scroll"

payload = {
    "x": 640,
    "y": 400,
    "direction": "down",
    "amount": 3
}
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: 400, direction: 'down', amount: 3})
};

fetch('https://www.orgo.ai/api/computers/{id}/scroll', 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}/scroll",
  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' => 400,
    'direction' => 'down',
    'amount' => 3
  ]),
  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}/scroll"

	payload := strings.NewReader("{\n  \"x\": 640,\n  \"y\": 400,\n  \"direction\": \"down\",\n  \"amount\": 3\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}/scroll")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"x\": 640,\n  \"y\": 400,\n  \"direction\": \"down\",\n  \"amount\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": 400,\n  \"direction\": \"down\",\n  \"amount\": 3\n}"

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

{
  "success": true,
  "action": "scroll",
  "details": {
    "direction": "down",
    "amount": 3
  },
  "error": null,
  "error_type": null
}

Moves the pointer to x, y and scrolls the wheel there. A Windows computer scrolls at the pointer’s current position instead.

On Linux, always send x and y. The pointer is moved before every scroll, and omitting either coordinate moves it to 0 on that axis. A request of {"direction": "down", "amount": 3} warps the pointer to the top-left corner and scrolls whatever happens to be under it. On Linux there is no way to scroll at the pointer’s current position through this endpoint.

A Windows computer scrolls at the pointer’s current position and ignores ?screen=. Send it only direction and amount, both required: direction must be up or down and amount from 1 to 50. Any other field, including x and y, or a value outside those rules returns 400. A successful response is {"ok": true}.

Path parameters

string

required

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

Query parameters

string

Which screen to scroll 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. A Windows computer ignores this parameter.

Body parameters

integer

required

X coordinate to move the pointer to before scrolling, in pixels from the left edge. Nominally optional, but omitting it moves the pointer to x = 0. See the warning above. A Windows computer refuses this field with 400.

integer

required

Y coordinate to move the pointer to before scrolling, in pixels from the top edge. Nominally optional, but omitting it moves the pointer to y = 0. See the warning above. A Windows computer refuses this field with 400.

string

default:"down"

Scroll direction: up or down. Optional on Linux: omitting it scrolls down, and so does any value other than the exact string up. Required on Windows.

integer

default:"1"

Number of wheel clicks. Optional on Linux: omitting it, or sending 0, scrolls once, and a negative value moves the pointer, scrolls nothing, and still returns 200. Required on Windows, from 1 to 50.

Response

boolean

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

string

Always scroll.

object

Carries direction and amount after defaults are applied. The coordinates the pointer was moved to are not echoed back.

Example

# Scroll down 3 clicks over (640, 400)
curl -X POST https://www.orgo.ai/api/computers/$COMPUTER_ID/scroll \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"x": 640, "y": 400, "direction": "down", "amount": 3}'

# Scroll up 10 clicks over the same point
curl -X POST https://www.orgo.ai/api/computers/$COMPUTER_ID/scroll \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"x": 640, "y": 400, "direction": "up", "amount": 10}'

import requests

requests.post(
    f"https://www.orgo.ai/api/computers/{computer_id}/scroll",
    headers={"Authorization": f"Bearer {api_key}", "Content-Type": "application/json"},
    json={"x": 640, "y": 400, "direction": "down", "amount": 3}
)

await fetch(`https://www.orgo.ai/api/computers/${computerId}/scroll`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ x: 640, y: 400, direction: 'down', amount: 3 })
});

Response

{
  "success": true,
  "action": "scroll",
  "details": { "direction": "down", "amount": 3 },
  "error": null,
  "error_type": null
}

Errors

Status	Meaning
`400`	The computer has no VM attached: `{"error": "Desktop instance not available"}`. Also returned by the computer agent when a body field has the wrong JSON type, such as `amount` sent as a string rather than a number. A Windows computer also returns it for a body outside its rules, as `{"error": "Request failed with status code 400"}` with `upstream_status: 400`.
`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` here, with `{"error": "Service temporarily unavailable. …"}`. 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."}`.
`404`	No computer with this id: `{"error": "Desktop not found"}`. Also returned when `?screen=` names a screen this computer does not have.
`500`	The computer agent could not move the pointer or scroll, or the request body is not valid JSON.
`503`	The computer could not be reached: `{"error": "Could not reach the desktop. Try again in a moment.", "code": "ECONNREFUSED"}`. Safe to retry. A computer that never finished provisioning also returns `503`, with `{"error": "Computer not ready"}`.

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": "moving mouse for scroll: exit status 1",
  "request_id": "9f2b7c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "upstream_status": 500
}

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 act on. Omit for the boot screen. An unknown id returns 404 rather than falling back.

Body

application/json

integer

required

X coordinate to move the pointer to before scrolling, in pixels from the left edge. The pointer is moved before every scroll, so omitting this warps it to x = 0 and scrolls whatever is under that point. Always send it.

integer

required

Y coordinate to move the pointer to before scrolling, in pixels from the top edge. The pointer is moved before every scroll, so omitting this warps it to y = 0 and scrolls whatever is under that point. Always send it.

direction

enum<string>

default:down

Scroll direction. Optional. Omitting it scrolls down, and so does any value other than the exact string up.

Available options:

up,

down

amount

integer

default:1

Number of wheel clicks. Optional. Omitting it, or sending 0, scrolls once. A negative value moves the pointer, scrolls nothing, and still returns 200.

Response

Scroll performed

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.

Scroll

curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/scroll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "x": 640,
  "y": 400,
  "direction": "down",
  "amount": 3
}
'

import requests

url = "https://www.orgo.ai/api/computers/{id}/scroll"

payload = {
    "x": 640,
    "y": 400,
    "direction": "down",
    "amount": 3
}
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: 400, direction: 'down', amount: 3})
};

fetch('https://www.orgo.ai/api/computers/{id}/scroll', 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}/scroll",
  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' => 400,
    'direction' => 'down',
    'amount' => 3
  ]),
  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}/scroll"

	payload := strings.NewReader("{\n  \"x\": 640,\n  \"y\": 400,\n  \"direction\": \"down\",\n  \"amount\": 3\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}/scroll")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"x\": 640,\n  \"y\": 400,\n  \"direction\": \"down\",\n  \"amount\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": 400,\n  \"direction\": \"down\",\n  \"amount\": 3\n}"

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

{
  "success": true,
  "action": "scroll",
  "details": {
    "direction": "down",
    "amount": 3
  },
  "error": null,
  "error_type": null
}

Overview

Account

Clients

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Scroll

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