Orgo - Cloud computers for AI agents

GET

files

List files

curl --request GET \
  --url https://www.orgo.ai/api/files \
  --header 'Authorization: Bearer <token>'

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

fetch('https://www.orgo.ai/api/files', 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",
  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/files"

	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/files")

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

{
  "files": [
    {
      "id": "<string>",
      "desktop_id": "<string>",
      "filename": "<string>",
      "size_bytes": "102400",
      "content_type": "<string>",
      "source": "upload",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Lists the files stored in a workspace, newest first. Pass desktopId to filter to a single computer.

Query parameters

string

required

Workspace ID. Omitting it returns 400.

string

Computer UUID to filter by. When omitted, every file in the workspace is returned, whichever computer it belongs to. A value that is not a UUID, such as an instance id, returns 500.

Response

array

File objects, ordered by created_at descending, newest first. An empty array when the workspace holds no files.

string

File ID. Pass it as id to the download and delete endpoints.

string

Original file name.

string | null

Size in bytes as a decimal string, such as "1024", or null when no size was recorded. The value is a 64-bit integer, so it is serialized as a string. Parse it before doing arithmetic.

string | null

MIME type, or null when none was recorded.

string

How the file entered the workspace: upload or export.

string | null

Computer the file is associated with, or null when it is not tied to one.

string

ISO 8601 creation timestamp.

Example

# Every file in the workspace
curl "https://www.orgo.ai/api/files?workspaceId=$WORKSPACE_ID" \
  -H "Authorization: Bearer $ORGO_API_KEY"

# Only the files tied to one computer
curl "https://www.orgo.ai/api/files?workspaceId=$WORKSPACE_ID&desktopId=$COMPUTER_ID" \
  -H "Authorization: Bearer $ORGO_API_KEY"

import os
import requests

response = requests.get(
    "https://www.orgo.ai/api/files",
    headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
    params={
        "workspaceId": os.environ["WORKSPACE_ID"],
        "desktopId": os.environ["COMPUTER_ID"],  # optional
    },
)

files = response.json()["files"]
for f in files:
    print(f"{f['filename']} ({f['size_bytes']} bytes, {f['source']})")

const params = new URLSearchParams({
  workspaceId: process.env.WORKSPACE_ID,
  desktopId: process.env.COMPUTER_ID, // optional
});

const response = await fetch(`https://www.orgo.ai/api/files?${params}`, {
  headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}` },
});

const { files } = await response.json();
files.forEach((f) => {
  console.log(`${f.filename} (${f.size_bytes} bytes, ${f.source})`);
});

Response

{
  "files": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "filename": "results.txt",
      "size_bytes": "1024",
      "created_at": "2024-01-15T11:00:00Z",
      "desktop_id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "content_type": "text/plain",
      "source": "export"
    },
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "filename": "document.pdf",
      "size_bytes": "102400",
      "created_at": "2024-01-15T10:30:00Z",
      "desktop_id": null,
      "content_type": "application/pdf",
      "source": "upload"
    }
  ]
}

Errors

Every error carries the shape {"error": "<message>"}.

Status	Body	Cause
`400`	`{"error": "workspaceId is required"}`	The `workspaceId` query parameter was absent.
`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.
`401`	`{"error": "You do not have access to this workspace."}`	The caller neither owns the workspace nor belongs to it, or `desktopId` names a computer in such a workspace. A workspace ID that does not exist also returns this. This endpoint never returns 404.
`401`	`{"error": "This API key cannot access this workspace (workspace_scope_mismatch)."}`	A workspace-scoped key named a different workspace, or a computer in one.
`401`	`{"error": "Service temporarily unavailable. …"}`	Orgo could not verify the credential because of a server-side fault. Retry.
`500`	`{"error": "Failed to list files"}`	The lookup failed, for example because `desktopId` is not a UUID. The message may instead carry the underlying database error.

Authorizations

Authorization

string

header

required

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

Query Parameters

workspaceId

string

required

Workspace ID. Required; omitting it is a 400.

desktopId

string

Restrict the list to files attached to one computer. Omitted, every file in the workspace is returned.

Response

List of files

files

object[]

Show child attributes

List files

curl --request GET \
  --url https://www.orgo.ai/api/files \
  --header 'Authorization: Bearer <token>'

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

fetch('https://www.orgo.ai/api/files', 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",
  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/files"

	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/files")

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

{
  "files": [
    {
      "id": "<string>",
      "desktop_id": "<string>",
      "filename": "<string>",
      "size_bytes": "102400",
      "content_type": "<string>",
      "source": "upload",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Overview

Account

Clients

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

List files

Query parameters

Response

Example

Response

Errors

Authorizations

Query Parameters

Response

​Query parameters

​Response

​Example

​Response

​Errors

Authorizations

Query Parameters

Response

Query parameters

Response

Example

Response

Errors