Orgo - Cloud computers for AI agents

POST

workflows

curl --request POST \
  --url https://www.orgo.ai/api/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Morning report",
  "describe": "Every weekday at 9 AM, read yesterday’s new Stripe customers and post a summary in #sales on Slack."
}
'

{
  "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": "<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": "<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>"
}

Makes a new workflow. Send describe (plain words: Orgo drafts the steps) or lines (the steps themselves), one of the two. The workflow’s id is its name in lowercase words joined by -, so Morning report is morning-report. A new workflow is off. Fix what to_fix says, check it with Validate, then turn it on with Update a workflow and { "on": true }.

Headers

string

8 to 255 printable characters. A retry with the same key and body within a day answers with the workflow the first request made, and makes nothing new. The same key with another body answers 409 with code: "idempotency_key_reused".

Request body

string

A few words, at most 40 characters. Left out, the name the lines or the draft give the start, else the first words of describe.

string

What it does, in plain words, at most 2,000 characters: what starts it and each step. Orgo’s drafting model writes the lines. Needs a key with AI write as well as Workflows write. Send this or lines.

string

The workflow, one JSON object per line, the start first. The format is at orgo.ai/workflows.md. Send this or describe.

string

An IANA zone its times are read in, like America/New_York. You can also set it later with Update a workflow.

Response

201, with the version in the ETag header.

string

The workflow’s id.

string | null

Its name.

boolean

false: a new workflow is off.

integer

Send it as If-Match on a later write.

string

The workflow as kept, one JSON object per step.

object

What it asks for once, name to value. Empty for a new workflow.

string[]

What still has to be done before it can run, in plain words, like Fill in channel.

object[]

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

string[]

Present when something you sent was left out or rewritten, naming each.

Example

curl -X POST https://www.orgo.ai/api/workflows \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Morning report","describe":"Every weekday at 9 AM, write a short report on yesterday’s new customers and post it in #sales on Slack."}'

import os, uuid, requests

r = requests.post(
    "https://www.orgo.ai/api/workflows",
    headers={
        "Authorization": f"Bearer {os.environ['ORGO_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={"name": "Morning report", "lines": open("morning-report.jsonl").read()},
)
workflow = r.json()
print(workflow["id"], workflow["to_fix"])

import { readFileSync } from "node:fs";

const r = await fetch("https://www.orgo.ai/api/workflows", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ORGO_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({ name: "Morning report", lines: readFileSync("morning-report.jsonl", "utf8") }),
});
const workflow = await r.json();

Response

{
  "id": "morning-report",
  "name": "Morning report",
  "on": false,
  "version": 1,
  "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

Every error is { "error", "code" }, often with say (a few words) and next (the call that fixes it).

Status	Code	When
`400`	`invalid_body`	Neither `describe` nor `lines`, or both; a name with no letters or digits; `describe` past 2,000 characters; or an `Idempotency-Key` that is not 8 to 255 printable characters.
`401`		No key, or a key Orgo doesn’t know.
`403`	`key_permission`	A restricted key without Workflows write, or `describe` from a key without AI write.
`404`	(no body)	Workflows aren’t open to your account.
`409`	`already_exists`	A workflow with that id exists. The body carries its `id`; change it with Replace a workflow’s steps, or pick another name.
`409`	`reserved_name`	The name would take one of Orgo’s own ids, like `live` or `draft`.
`409`	`too_many_workflows`	You have 200 workflows, the most an account can have.
`409`	`idempotency_key_reused`	That key was used with another body.
`409`	`idempotency_busy`	A request with that key is still going. Retry after `retry_after` seconds.
`413`	`body_too_large`	The body is over 128 KB.
`422`	`invalid_lines`	Lines that could not be read, named in `dropped`. Nothing was made.
`422`	`draft_unusable`	The description could not be drafted as a workflow. Say it another way, naming the start and each step.
`429`	`rate_limited`	Too many writes or drafts. Carries `Retry-After`.
`502`	`draft_failed`	The drafting model didn’t answer. Nothing was made. Retry.
`503`	`draft_unconfigured`	Drafting isn’t set up here. Send `lines`.
`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

Headers

Idempotency-Key

string

A retry with the same key and body answers as the first request did, for a day.

Required string length: 8 - 255

Body

application/json

describe or lines, one of the two.

name

string

Maximum string length: 40

describe

string

What it does, in plain words. Orgo drafts the steps.

Maximum string length: 2000

lines

string

The steps themselves, one JSON object per line (https://www.orgo.ai/workflows.md).

time_zone

string

An IANA zone its times are read in, like America/New_York.

Response

The workflow, made.

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.

curl --request POST \
  --url https://www.orgo.ai/api/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Morning report",
  "describe": "Every weekday at 9 AM, read yesterday’s new Stripe customers and post a summary in #sales on Slack."
}
'

{
  "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": "<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": "<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>"
}

Overview

API keys

Support

Account

Agent accounts

Clients

Computer Use API

Workspaces

Computers

Computer Lifecycle

Computer Actions

Screens

Files

Templates

Workflows

Create a workflow

Headers

Request body

Response

Example

Response

Errors

Authorizations

Headers

Body

Response

​Headers

​Request body

​Response

​Example

​Response

​Errors

Authorizations

Headers

Body

Response

Headers

Request body

Response

Example

Response

Errors