Orgo - Cloud computers for AI agents

POST

computers

{id}

type

Type text

curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/type \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Hello, world!"
}
'

import requests

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

payload = { "text": "Hello, world!" }
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({text: 'Hello, world!'})
};

fetch('https://www.orgo.ai/api/computers/{id}/type', 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}/type",
  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([
    'text' => 'Hello, world!'
  ]),
  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}/type"

	payload := strings.NewReader("{\n  \"text\": \"Hello, world!\"\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}/type")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"Hello, world!\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"text\": \"Hello, world!\"\n}"

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

{
  "success": true,
  "action": "type",
  "details": {
    "text_length": 13
  },
  "error": null,
  "error_type": null
}

Types text on the computer keyboard. Each character is sent as an individual keystroke, so unicode characters and printable symbols are supported.

Path parameters

string

required

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

Query parameters

string

Which screen to type 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

string

required

Text to type. Unicode is supported. Nothing checks that it is present: omitting it types the empty string and still returns 200 (with text_length: 0 on Linux), so a body that lost its text looks like a success.

integer

default:"12"

Delay between keystrokes, in milliseconds. Optional. Omitting it, or sending 0, uses 12. Lower values type faster; higher values help with inputs that drop fast keystrokes. A Windows computer refuses this field with 400.

The API waits at most 30 seconds for the computer to finish typing. The text takes about delay_ms per character, so at the default of 12 ms anything over roughly 2,500 characters returns 503 with code: "ECONNABORTED", and the text may be only partly typed. Split long text into several requests.

A Windows computer ignores ?screen= and accepts only text in the body. Any other field, including delay_ms, returns 400, and so does text longer than 20,000 bytes. A successful response is {"ok": true}.

Response

boolean

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

string

Always type.

object

Carries text_length, the length of the typed text in bytes, not characters. A non-ASCII character counts as more than one.

Example

curl -X POST https://www.orgo.ai/api/computers/$COMPUTER_ID/type \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello, world!"}'

import requests

requests.post(
    f"https://www.orgo.ai/api/computers/{computer_id}/type",
    headers={"Authorization": f"Bearer {api_key}", "Content-Type": "application/json"},
    json={"text": "Hello, world!"}
)

await fetch(`https://www.orgo.ai/api/computers/${computerId}/type`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ text: 'Hello, world!' })
});

Response

{
  "success": true,
  "action": "type",
  "details": { "text_length": 13 },
  "error": null,
  "error_type": null
}

Use Press key for special keys like Enter, Tab, or keyboard shortcuts.

Errors

Status	Meaning
`400`	The computer has no VM attached: `{"error": "Desktop instance not available"}`. Also returned by the computer agent when `text` is not a JSON string. A Windows computer also returns it for any field other than `text` or for `text` over 20,000 bytes, as `{"error": "Request failed with status code 400"}` with `upstream_status: 400`. A missing `text` is not a `400`: it is a `200` that types nothing.
`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 type the text, 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"}`. Text that takes longer than 30 seconds to type also lands here, with `code: "ECONNABORTED"`; it may be only partly typed, so check before retrying.

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": "typing text: 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

text

string

required

Text to type. Unicode is supported. Not validated: omitting it types the empty string and still returns 200.

delay_ms

integer

default:12

Delay between keystrokes, in milliseconds. Omitted or 0, 12 is used. The API waits at most 30 seconds for the typing to finish; longer text returns 503 with code: "ECONNABORTED", and the text may be only partly typed.

Response

Text typed. details.text_length is the length in bytes, not characters.

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.

Type text

curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/type \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Hello, world!"
}
'

import requests

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

payload = { "text": "Hello, world!" }
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({text: 'Hello, world!'})
};

fetch('https://www.orgo.ai/api/computers/{id}/type', 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}/type",
  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([
    'text' => 'Hello, world!'
  ]),
  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}/type"

	payload := strings.NewReader("{\n  \"text\": \"Hello, world!\"\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}/type")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"Hello, world!\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"text\": \"Hello, world!\"\n}"

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

{
  "success": true,
  "action": "type",
  "details": {
    "text_length": 13
  },
  "error": null,
  "error_type": null
}

Overview

Account

Clients

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Type text

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