Orgo - Cloud computers for AI agents

GET

workflows

{id}

Get a workflow

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

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

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

	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/workflows/{id}")

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

{
  "id": "morning-report",
  "name": "Morning report",
  "on": false,
  "version": 3,
  "lines": "{\"id\":\"a\",\"kind\":\"start\",\"title\":\"9:00 AM\",\"sub\":\"Weekdays\",\"name\":\"Morning report\"}\n{\"id\":\"b\",\"after\":[\"a\"],\"kind\":\"agent\",\"agent\":\"hermes\",\"title\":\"Write the report\",\"task\":\"Write a short report on yesterday’s new customers.\"}\n{\"id\":\"c\",\"after\":[\"b\"],\"kind\":\"app\",\"app\":\"slack\",\"title\":\"Post\",\"where\":\"{channel}\",\"message\":\"{report}\"}",
  "settings": {},
  "to_fix": [
    "Fill in channel"
  ],
  "problems": [
    {
      "step": "a",
      "say": "Fill in channel"
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "say": "<string>",
  "next": "<string>",
  "to_fix": [
    "<string>"
  ],
  "problems": [
    {}
  ],
  "version": 123,
  "lines": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "say": "<string>",
  "next": "<string>",
  "to_fix": [
    "<string>"
  ],
  "problems": [
    {}
  ],
  "version": 123,
  "lines": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "say": "<string>",
  "next": "<string>",
  "to_fix": [
    "<string>"
  ],
  "problems": [
    {}
  ],
  "version": 123,
  "lines": "<string>"
}

{
  "error": "Too many API requests this minute (120 a minute on your plan). Try again in 12 seconds.",
  "code": "rate_limited",
  "limit": "api_other_per_minute",
  "retry_after": 12
}

{
  "error": "Service temporarily unavailable. The database is not accepting requests. Retry shortly."
}

Returns one workflow. Its lines are what you edit and send back with Replace a workflow’s steps, and its version (also the ETag header) is what you send back as If-Match.

Path parameters

string

required

The workflow’s id, like morning-report, from List workflows.

Response

string

The workflow’s id.

string | null

Its name.

boolean

true when its start runs it.

integer

The version. Send it as If-Match on a write.

string

The workflow, one JSON object per step, the start first. The format is at orgo.ai/workflows.md.

object

What it asks for once, name to value, like { "channel": "sales" }.

string[]

What still has to be done before it can run, in plain words. Empty when it is ready.

object[]

The same, each with the step it is on and say. A setting to fill in is on the start.

Example

curl https://www.orgo.ai/api/workflows/morning-report \
  -H "Authorization: Bearer $ORGO_API_KEY"

import os, requests

r = requests.get(
    "https://www.orgo.ai/api/workflows/morning-report",
    headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
)
workflow = r.json()
print(workflow["version"], workflow["to_fix"])

const r = await fetch("https://www.orgo.ai/api/workflows/morning-report", {
  headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}` },
});
const workflow = await r.json();

Response

{
  "id": "morning-report",
  "name": "Morning report",
  "on": false,
  "version": 3,
  "lines": "{\"id\":\"a\",\"kind\":\"start\",\"title\":\"9:00 AM\",\"sub\":\"Weekdays\",\"name\":\"Morning report\"}\n{\"id\":\"b\",\"after\":[\"a\"],\"kind\":\"agent\",\"agent\":\"hermes\",\"title\":\"Write the report\",\"task\":\"Write a short report on yesterday’s new customers.\"}\n{\"id\":\"c\",\"after\":[\"b\"],\"kind\":\"app\",\"app\":\"slack\",\"title\":\"Post\",\"where\":\"{channel}\",\"message\":\"{report}\"}",
  "settings": {},
  "to_fix": ["Fill in channel"],
  "problems": [{ "step": "a", "say": "Fill in channel" }]
}

Errors

Status	Code	When
`401`		No key, or a key Orgo doesn’t know.
`403`	`key_permission`	A restricted key without Workflows read.
`404`	`not_found`	No workflow by that id. `next` says to list them with `GET /api/workflows`.
`404`	(no body)	Workflows aren’t open to your account.
`429`	`rate_limited`	Your plan’s rate limit for other API calls. Carries `Retry-After`.
`503`		Orgo couldn’t verify the key because of a server-side fault. Retry.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Pattern: ^[a-z0-9-]{1,60}$

Response

The workflow.

string

required

Pattern: ^[a-z0-9-]{1,60}$

name

string | null

required

boolean

required

Whether its start runs it. It is on only while it can run.

version

integer

required

Send it as If-Match on a write.

lines

string

required

The workflow, one JSON object per step, the start first (https://www.orgo.ai/workflows.md).

settings

object

required

What it asks for once, name to value.

Show child attributes

to_fix

string[]

required

What still has to be done before it can run, in the person’s words. Empty: ready.

problems

object[]

required

Show child attributes

turned_off

boolean

This write left it unable to run, so it was turned off.

dropped

string[]

What of the lines sent was left out or rewritten.

Get a workflow

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

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

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

	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/workflows/{id}")

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

{
  "id": "morning-report",
  "name": "Morning report",
  "on": false,
  "version": 3,
  "lines": "{\"id\":\"a\",\"kind\":\"start\",\"title\":\"9:00 AM\",\"sub\":\"Weekdays\",\"name\":\"Morning report\"}\n{\"id\":\"b\",\"after\":[\"a\"],\"kind\":\"agent\",\"agent\":\"hermes\",\"title\":\"Write the report\",\"task\":\"Write a short report on yesterday’s new customers.\"}\n{\"id\":\"c\",\"after\":[\"b\"],\"kind\":\"app\",\"app\":\"slack\",\"title\":\"Post\",\"where\":\"{channel}\",\"message\":\"{report}\"}",
  "settings": {},
  "to_fix": [
    "Fill in channel"
  ],
  "problems": [
    {
      "step": "a",
      "say": "Fill in channel"
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "say": "<string>",
  "next": "<string>",
  "to_fix": [
    "<string>"
  ],
  "problems": [
    {}
  ],
  "version": 123,
  "lines": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "say": "<string>",
  "next": "<string>",
  "to_fix": [
    "<string>"
  ],
  "problems": [
    {}
  ],
  "version": 123,
  "lines": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "say": "<string>",
  "next": "<string>",
  "to_fix": [
    "<string>"
  ],
  "problems": [
    {}
  ],
  "version": 123,
  "lines": "<string>"
}

{
  "error": "Too many API requests this minute (120 a minute on your plan). Try again in 12 seconds.",
  "code": "rate_limited",
  "limit": "api_other_per_minute",
  "retry_after": 12
}

{
  "error": "Service temporarily unavailable. The database is not accepting requests. Retry shortly."
}

Overview

API keys

Support

Account

Agent accounts

Clients

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Workflows

Get a workflow

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