Orgo - Cloud computers for AI agents

POST

files

export

Export file (unavailable)

curl --request POST \
  --url https://www.orgo.ai/api/files/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "desktopId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "path": "Desktop/results.txt"
}
'

import requests

url = "https://www.orgo.ai/api/files/export"

payload = {
    "desktopId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "path": "Desktop/results.txt"
}
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({desktopId: 'a3bb189e-8bf9-3888-9912-ace4e6543002', path: 'Desktop/results.txt'})
};

fetch('https://www.orgo.ai/api/files/export', 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/files/export",
  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([
    'desktopId' => 'a3bb189e-8bf9-3888-9912-ace4e6543002',
    'path' => 'Desktop/results.txt'
  ]),
  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/files/export"

	payload := strings.NewReader("{\n  \"desktopId\": \"a3bb189e-8bf9-3888-9912-ace4e6543002\",\n  \"path\": \"Desktop/results.txt\"\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/files/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"desktopId\": \"a3bb189e-8bf9-3888-9912-ace4e6543002\",\n  \"path\": \"Desktop/results.txt\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/files/export")

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  \"desktopId\": \"a3bb189e-8bf9-3888-9912-ace4e6543002\",\n  \"path\": \"Desktop/results.txt\"\n}"

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

{
  "success": true,
  "file": {
    "id": "<string>",
    "filename": "<string>",
    "size_bytes": 123,
    "content_type": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "url": "<string>"
}

This endpoint is not currently available. Every call fails with 404. The API accepts the request and forwards it to the computer. The software running on the computer implements no export handler, so the request has nowhere to land. No set of arguments makes it succeed. This page records the intended contract and the behaviour you will observe today. Do not build against it.

Intended to copy a file off a computer’s filesystem into workspace storage and return a download URL.

Request

Send a JSON body.

string

required

Computer ID to export from. Omitting it returns 400.

string

required

Path to the file on the computer. Omitting it returns 400. The value is forwarded to the computer unchanged. How it would be resolved is not defined, because no handler on the computer reads it.

Response

There is no success response. The request is rejected before any file is read. Calls that get as far as the computer return:

{
  "error": "VM export failed: 404"
}

with HTTP status 404.

Example

The call below is well-formed against a running computer and still returns 404.

curl -X POST https://www.orgo.ai/api/files/export \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"desktopId\": \"$COMPUTER_ID\", \"path\": \"/root/Desktop/results.txt\"}"

import os
import requests

response = requests.post(
    "https://www.orgo.ai/api/files/export",
    headers={
        "Authorization": f"Bearer {os.environ['ORGO_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "desktopId": os.environ["COMPUTER_ID"],
        "path": "/root/Desktop/results.txt",
    },
)

print(response.status_code, response.json())  # 404 {'error': 'VM export failed: 404'}

const response = await fetch('https://www.orgo.ai/api/files/export', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.ORGO_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    desktopId: process.env.COMPUTER_ID,
    path: '/root/Desktop/results.txt',
  }),
});

console.log(response.status, await response.json()); // 404 { error: 'VM export failed: 404' }

Getting a file off a computer today

Read the file over the computer’s shell and write it where you want it. To send a file the other way, use the upload endpoint: its destPath field places a file at an exact path on a computer.

Errors

Every error carries the shape {"error": "<message>"}. The checks below run in order, so the first one that fails is the status you get.

Status	Body	Cause
`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.
`400`	`{"error": "Missing desktopId or path"}`	Either field was absent or empty.
`404`	`{"error": "Desktop not found"}`	No computer has that ID.
`403`	`{"error": "Access denied"}`	The caller neither owns the computer’s workspace nor belongs to it.
`400`	`{"error": "Desktop is not running"}`	The computer’s status is anything other than `running`.
`400`	`{"error": "Desktop has no instance ID"}`	The computer record carries no instance ID.
`503`	`{"error": "Computer not ready"}`	The computer has no connection details recorded, so it cannot be addressed.
`404`	`{"error": "VM export failed: 404"}`	The computer has no export handler. Every request that reaches this point ends here.
`500`	`{"error": "Export failed"}`	Unexpected failure. The message may instead carry the underlying error.

A failure reported by the computer is relayed with the computer’s own status code and its own error message, so statuses outside this list are possible if the software on the computer changes.

Authorizations

Authorization

string

header

required

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

Body

application/json

desktopId

string

required

Computer ID

path

string

required

Path to file on computer (e.g., Desktop/results.txt)

Response

The intended success shape. Not returned today. See the description.

success

boolean

file

object

Show child attributes

url

string

Signed download URL (expires in 1 hour)

Export file (unavailable)

curl --request POST \
  --url https://www.orgo.ai/api/files/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "desktopId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "path": "Desktop/results.txt"
}
'

import requests

url = "https://www.orgo.ai/api/files/export"

payload = {
    "desktopId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "path": "Desktop/results.txt"
}
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({desktopId: 'a3bb189e-8bf9-3888-9912-ace4e6543002', path: 'Desktop/results.txt'})
};

fetch('https://www.orgo.ai/api/files/export', 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/files/export",
  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([
    'desktopId' => 'a3bb189e-8bf9-3888-9912-ace4e6543002',
    'path' => 'Desktop/results.txt'
  ]),
  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/files/export"

	payload := strings.NewReader("{\n  \"desktopId\": \"a3bb189e-8bf9-3888-9912-ace4e6543002\",\n  \"path\": \"Desktop/results.txt\"\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/files/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"desktopId\": \"a3bb189e-8bf9-3888-9912-ace4e6543002\",\n  \"path\": \"Desktop/results.txt\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/files/export")

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  \"desktopId\": \"a3bb189e-8bf9-3888-9912-ace4e6543002\",\n  \"path\": \"Desktop/results.txt\"\n}"

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

{
  "success": true,
  "file": {
    "id": "<string>",
    "filename": "<string>",
    "size_bytes": 123,
    "content_type": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "url": "<string>"
}

Overview

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Export file

Request

Response

Example

Getting a file off a computer today

Errors

Authorizations

Body

Response

​Request

​Response

​Example

​Getting a file off a computer today

​Errors

Authorizations

Body

Response

Request

Response

Example

Getting a file off a computer today

Errors