Orgo - Cloud computers for AI agents

GET

template-schema

Get template schema

curl --request GET \
  --url https://www.orgo.ai/api/template-schema

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.orgo.ai/api/template-schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/template-schema"

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

	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/template-schema")

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

request = Net::HTTP::Get.new(url)

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

{}

Returns the complete orgo.ai/v1 template schema as JSON Schema (Draft 2020-12). It covers every field, its type, accepted values, and a description. This is the canonical machine-readable contract for templates, consumed by editors, the CLI, and AI agents.

This endpoint is public. It requires no API key, sets permissive CORS headers, and is cacheable, so any tool can fetch it directly. It serves a static document, so the only status it returns is 200.

The schema models the canonical form only. It requires api_version and template and sets additionalProperties: false, so a document in the sugar form validates as invalid against it: once for the missing template block, and once per sugar key. Sugar is desugared server-side, so check a sugar document with Validate template.

Response

A JSON Schema document. The top-level properties describe each template field; $defs holds the reusable sub-objects (hardware, app, service, trigger, and so on). For a guided walkthrough, see the schema reference.

Example

curl https://www.orgo.ai/api/template-schema

import requests

schema = requests.get("https://www.orgo.ai/api/template-schema").json()
print(schema["title"])  # "Orgo Template (orgo.ai/v1)"
print(list(schema["properties"]))

const schema = await (
  await fetch("https://www.orgo.ai/api/template-schema")
).json();
console.log(schema.title);

Response (excerpt)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://orgo.ai/schemas/template/orgo.ai-v1.json",
  "title": "Orgo Template (orgo.ai/v1)",
  "type": "object",
  "required": ["api_version", "template"],
  "properties": {
    "api_version": { "type": "string", "enum": ["orgo.ai/v1"] },
    "template": { "$ref": "#/$defs/metadata" },
    "hardware": { "$ref": "#/$defs/hardware" }
  }
}

Point your editor’s YAML language server at this URL for inline autocomplete and validation of a canonical template:

# yaml-language-server: $schema=https://www.orgo.ai/api/template-schema
api_version: orgo.ai/v1
template:
  name: my-workstation
  version: 1.0.0

Response

200 - application/schema+json

The orgo.ai/v1 JSON Schema document.

The response is of type object.

Get template schema

curl --request GET \
  --url https://www.orgo.ai/api/template-schema

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.orgo.ai/api/template-schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/template-schema"

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

	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/template-schema")

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

request = Net::HTTP::Get.new(url)

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

{}

Overview

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Get template schema

Response

Example

Response (excerpt)

Response

​Response

​Example

​Response (excerpt)

Response

Response

Example

Response (excerpt)