Orgo - Cloud computers for AI agents

POST

templates

{namespace}

{name}

{version}

build

Build template

curl --request POST \
  --url https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

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

fetch('https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build', 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/templates/{namespace}/{name}/{version}/build",
  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/templates/{namespace}/{name}/{version}/build"

	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))

}

HttpResponse<String> response = Unirest.post("https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build")

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

{
  "ref": "<string>",
  "digest": "<string>",
  "golden_dir": "<string>",
  "build_time_ms": 123,
  "reused": true,
  "error": "<string>"
}

{
  "error": "Invalid API key"
}

{
  "error": "<string>"
}

{
  "error": "Resource not found"
}

{
  "error": "<string>"
}

Builds the golden snapshot for a version: Orgo boots a VM, runs the build steps and app installs, then captures a paused snapshot. A built template launches in seconds; an unbuilt one cannot launch at all. This call is asynchronous - it returns immediately with 202 Accepted. Track progress by polling Get build status or streaming build logs. A typical build takes around two minutes.

Building templates requires a Scale plan. You can also build at publish time with POST /templates?auto_build=true.

Path parameters

string

required

Template namespace.

string

required

Template name.

string

required

Version (semver) to build.

Response

string

Template ref.

string

Content-addressed digest being built.

string

Build state: building, ready, failed, or not_built. A fresh build returns building; if an identical digest is already built, you get ready immediately with reused: true.

boolean

true when an existing golden with the same digest was reused instead of rebuilt.

Example

curl -X POST https://www.orgo.ai/api/templates/default/claude-code/1.0.0/build \
  -H "Authorization: Bearer $ORGO_API_KEY"

import os, requests, time

ref = "default/claude-code/1.0.0"
base = f"https://www.orgo.ai/api/templates/{ref}/build"
hdr = {"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"}

requests.post(base, headers=hdr)                 # kick off
while True:                                       # poll to ready
    status = requests.get(base, headers=hdr).json()["status"]
    print(status)
    if status in ("ready", "failed"):
        break
    time.sleep(5)

const base =
  "https://www.orgo.ai/api/templates/default/claude-code/1.0.0/build";
const hdr = { Authorization: `Bearer ${process.env.ORGO_API_KEY}` };

await fetch(base, { method: "POST", headers: hdr });
let status = "building";
while (status === "building") {
  await new Promise((r) => setTimeout(r, 5000));
  status = (await (await fetch(base, { headers: hdr })).json()).status;
}
console.log(status);

Response

{
  "ref": "default/claude-code@1.0.0",
  "digest": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2",
  "status": "building"
}

Cancel a build

Send a DELETE to the same build path to cancel an in-flight build. It returns 202 with { "status": "cancelling" }, or 404 with { "status": "idle" } when nothing is building.

curl -X DELETE https://www.orgo.ai/api/templates/default/claude-code/1.0.0/build \
  -H "Authorization: Bearer $ORGO_API_KEY"

Errors

Status	Meaning
`401`	Missing or invalid API key.
`403`	Building requires a Scale plan or higher.
`404`	No such template version.
`429`	Build rate limit or host capacity reached. Back off and retry.

Authorizations

Authorization

string

header

required

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

Path Parameters

namespace

string

required

name

string

required

version

string

required

Response

Build started (or reused)

ref

string

digest

string

status

enum<string>

Available options:

ready,

building,

failed,

not_built

golden_dir

string

build_time_ms

integer

Build duration in milliseconds. Present when ready.

reused

boolean

Whether an existing golden with the same digest was reused.

error

string

Failure reason. Present when status is failed.

Get build statusCheck whether a template version's golden snapshot is ready.

Build template

curl --request POST \
  --url https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

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

fetch('https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build', 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/templates/{namespace}/{name}/{version}/build",
  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/templates/{namespace}/{name}/{version}/build"

	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))

}

HttpResponse<String> response = Unirest.post("https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/templates/{namespace}/{name}/{version}/build")

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

{
  "ref": "<string>",
  "digest": "<string>",
  "golden_dir": "<string>",
  "build_time_ms": 123,
  "reused": true,
  "error": "<string>"
}

{
  "error": "Invalid API key"
}

{
  "error": "<string>"
}

{
  "error": "Resource not found"
}

{
  "error": "<string>"
}

Overview

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Files

Templates

Build template

Path parameters

Response

Example

Response

Cancel a build

Errors

Authorizations

Path Parameters

Response

​Path parameters

​Response

​Example

​Response

​Cancel a build

​Errors

Authorizations

Path Parameters

Response

Path parameters

Response

Example

Response

Cancel a build

Errors