Orgo - Cloud computers for AI agents

POST

computers

{id}

suspend

Suspend computer

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

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

fetch('https://www.orgo.ai/api/computers/{id}/suspend', 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}/suspend",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/suspend"

	req, _ := http.NewRequest("POST", 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}/suspend")

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

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

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

{
  "success": true,
  "status": "suspended"
}

Suspends a running computer. Its memory and disk are saved, so open windows and running processes pick up exactly where they were. A suspended computer may be moved off its host to storage. Resume or Start then wakes it in about a minute.

Suspend is available for Linux computers without a GPU. A computer that wakes from storage gets a new instance_id, so keep its UUID as your handle and re-fetch GET /computers/{id} after a wake. To release a computer and keep only its disk, use Stop instead.

Path parameters

string

required

Computer UUID or instance_id. Both resolve to the same computer.

Response

boolean

true when the computer is suspended, or its suspend is being saved.

string

suspended with 200: the computer is paused. suspending with 202: its memory is still being saved. Poll Get suspension until status reads suspended.

object

Present only when the computer’s copy is being saved to storage in the background: { "state": "saving", "region": "…" }. region can be null. The computer can be resumed or deleted meanwhile.

Suspending is idempotent. A computer that is already suspended returns 200 with status: "suspended", and one whose suspend is still being saved returns 202 with status: "suspending".

Example

curl -X POST https://www.orgo.ai/api/computers/$COMPUTER_ID/suspend \
  -H "Authorization: Bearer $ORGO_API_KEY"

import requests

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

print(response.json()["status"])

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

const { status } = await response.json();
console.log(status);

Response

{
  "success": true,
  "status": "suspended",
  "storage": { "state": "saving", "region": "nyc" }
}

Errors

Status	Body	When
`400`	`{ "error": "…", "code": "suspend_unsupported" }`	The computer cannot be suspended: it is not Linux, or it has a GPU. `code` is `DEVICE_LIFECYCLE_UNSUPPORTED` for a device Orgo manages directly.
`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.
`402`	`{ "error": "Choose a plan to continue." }`	The computer is a trial computer whose trial has ended. `error` is “Manage this computer’s payment in Account → Usage.” when its payment is managed there.
`403`	`{ "error": "You do not have access to this workspace." }`	You are not a member of the computer’s workspace.
`403`	`{ "error": "This workspace is view-only. Ask the owner for write access (workspace_read_only)." }`	You have view-only access to the workspace.
`403`	`{ "error": "This API key cannot access this workspace (workspace_scope_mismatch)." }`	The API key is scoped to a different workspace.
`404`	`{ "error": "Desktop not found" }`	No computer matches the id.
`409`	`{ "error": "Use Stop to save your files and release hourly compute.", "code": "HOURLY_USE_STOP" }`	The computer runs by the hour. Stop it instead.
`409`	`{ "error": "Manage this reservation in Account → Usage.", "code": "ALLOCATION_MANAGED" }`	The computer is part of a reservation.
`409`	`{ "error": "This computer is being moved to another host. Try again in a few minutes.", "code": "migrating" }`	The computer is being moved to another host.
`409`	`{ "error": "This computer is still finishing waking up. Try again in a minute.", "code": "converging" }`	The computer woke from storage moments ago and is still settling. Nothing was saved. Carries `Retry-After: 30`.
`409`	`{ "error": "Computer is not running (status: stopped)" }`	The computer is not `running`, `suspending`, or `suspended`.
`409`	`{ "error": "Computer can't be suspended right now (status: …)" }`	Its host refused the suspend and the computer is in another state there.
`500`	`{ "error": "…" }`	The suspend failed.
`503`	`{ "error": "Computer not ready. VMM has not assigned a server yet" }`	The computer has no host on record yet.
`503`	`{ "error": "Service temporarily unavailable. …" }`	Orgo could not verify the credential because of a server-side fault. The response carries `Retry-After: 5`. Retry after that delay.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Computer UUID or instance_id

Response

Suspended. storage is present when its copy is being saved to storage in the background.

success

boolean

status

enum<string>

Available options:

suspended

storage

object

Show child attributes

Suspend computer

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

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

fetch('https://www.orgo.ai/api/computers/{id}/suspend', 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}/suspend",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/suspend"

	req, _ := http.NewRequest("POST", 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}/suspend")

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

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

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

{
  "success": true,
  "status": "suspended"
}

Overview

Account

Agent accounts

Clients

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Suspend computer

Path parameters

Response

Example

Response

Errors

Authorizations

Path Parameters

Response

​Path parameters

​Response

​Example

​Response

​Errors

Authorizations

Path Parameters

Response

Path parameters

Response

Example

Response

Errors