Skip to main content
POST
Publish template
Publishes a template to your registry. The request body is a complete orgo.ai/v1 document, sent as YAML (Content-Type: application/yaml) or JSON. The body is parsed as YAML only when the content type contains yaml; anything else is parsed as JSON. A successful publish returns 201.
Publishing templates requires a Scale plan or higher. Launching a computer from a template, curated or your own, is separate: it needs a paid plan and counts against the workspace owner’s computer quota.
Refs are immutable. Once namespace/name@version is published, re-publishing the same ref with different content returns 409. Bump template.version to ship a change, or pass ?force=true to overwrite the version in place while iterating.

Query parameters

boolean
default:"false"
Set to true to build the golden snapshot immediately after publishing. Equivalent to calling Build template yourself. Omitted, the version is published unbuilt and cannot launch until you build it. Only the exact string true enables it.
boolean
default:"false"
Set to true to overwrite an existing version in place (delete + republish). Useful for fast iteration on a single version number. Omitted, re-publishing an existing ref with different content returns 409. Only the exact string true enables it.

Request body

The raw template document. Validate it first with Validate template to catch errors without writing anything.

Response

string
The published ref, namespace/name@version.
string
Content-addressed SHA-256 digest of the canonical template.
string
ISO 8601 publish timestamp.
string
Present only when ?auto_build=true. The status of the build that was kicked off, e.g. "building".

Example

Response

Errors

Branch on code rather than on the message text: UPGRADE_REQUIRED with upgradeTier is the upsell signal, and the rate-limit codes tell you what to back off from.

Authorizations

Authorization
string
header
required

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

Query Parameters

auto_build
boolean

Build the golden snapshot immediately after publishing.

force
boolean

Overwrite an existing version in place (delete + republish). Useful while iterating on one version number.

Body

The orgo.ai/v1 template document as YAML.

Response

Published

ref
string
Example:

"default/claude-code@1.0.0"

digest
string
published
string<date-time>
auto_build
string

Present only with ?auto_build=true. The kicked-off build's status, e.g. "building".