Orgo - Cloud computers for AI agents

GET

computers

{id}

vnc-password

Get VNC password

curl --request GET \
  --url https://www.orgo.ai/api/computers/{id}/vnc-password \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.orgo.ai/api/computers/{id}/vnc-password', 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}/vnc-password",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "password": "abc123xyz"
}

Returns the computer’s VNC credential and its Desktop API token.

These values grant direct access to the computer’s display, shell, and Desktop API. Treat them as secrets. They rotate whenever the computer restarts, is started again, or has its RAM resized, so fetch them fresh rather than caching them.

Path parameters

string

required

Computer UUID. This endpoint accepts the UUID only. Unlike the lifecycle endpoints, it does not resolve an instance_id, and passing one returns 500.

Response

string

The VNC credential. Use it as the password for a VNC client and as the token query parameter on the VNC and terminal WebSockets.

string

The Bearer token for the computer’s Desktop API: /bash, /events, and the terminal. Usually the same string as password, but a computer that carries its own stamped token returns that instead, so send this field rather than reusing password.

Access control

Workspace owners and workspace members can read these values. Anyone else gets 403. A workspace-scoped API key can only read them for computers in its own workspace.

Example

curl https://www.orgo.ai/api/computers/$COMPUTER_ID/vnc-password \
  -H "Authorization: Bearer $ORGO_API_KEY"

import requests

response = requests.get(
    f"https://www.orgo.ai/api/computers/{computer_id}/vnc-password",
    headers={"Authorization": f"Bearer {api_key}"}
)

body = response.json()
vnc_password = body["password"]
desktop_api_token = body["desktop_api_token"]

const response = await fetch(`https://www.orgo.ai/api/computers/${computerId}/vnc-password`, {
  headers: { 'Authorization': `Bearer ${apiKey}` }
});

const { password, desktop_api_token: desktopApiToken } = await response.json();

Response

{
  "password": "0a017c595fa7689753a3",
  "desktop_api_token": "0a017c595fa7689753a3"
}

Usage

VNC connections: pass password as the password in any VNC client.
VNC and terminal WebSockets: pass password as the token query parameter (see the Terminal WebSocket).
Desktop API: send desktop_api_token as the Bearer token on https://www.orgo.ai/api/desktops/{instance_id}/proxy/{endpoint}.

For programmatic control, use the Computer Actions endpoints instead of VNC. For interactive shell access, use the Terminal WebSocket.

Errors

Status	Body	When
`401`	`{ "error": "Invalid API key" }`	The Bearer token starts with `sk_` but is not a known Orgo key.
`401`	`{ "error": "Authentication required" }`	No `Authorization` header, or a Bearer token that is not an `sk_` key.
`403`	`{ "error": "Access denied" }`	You are neither the owner nor a member of the computer’s workspace.
`403`	`{ "error": "…", "code": "workspace_scope_mismatch", "key_workspace_id": "…", "target_workspace_id": "…" }`	The API key is scoped to a different workspace.
`404`	`{ "error": "Desktop not found" }`	No computer matches the UUID.
`404`	`{ "error": "Password not available" }`	The computer has no stored credential yet, such as a record still being provisioned.
`500`	`{ "error": "Failed to retrieve password" }`	The lookup or decryption failed, including when `id` is not a UUID.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Computer ID

Response

VNC password

password

string

VNC connection password

Get VNC password

curl --request GET \
  --url https://www.orgo.ai/api/computers/{id}/vnc-password \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.orgo.ai/api/computers/{id}/vnc-password', 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}/vnc-password",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "password": "abc123xyz"
}

Overview

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Get VNC password

Path parameters

Response

Access control

Example

Response

Usage

Errors

Authorizations

Path Parameters

Response

​Path parameters

​Response

​Access control

​Example

​Response

​Usage

​Errors

Authorizations

Path Parameters

Response

Path parameters

Response

Access control

Example

Response

Usage

Errors