Templates
Publish template
Publish a template document to your registry.
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
Set to
true to build the golden snapshot immediately after publishing. Like calling Build template yourself, except that nothing is queued when this exact content is already built. Omitted, the version is published unbuilt and cannot launch until you build it. Only the exact string true enables it.Set to
true to overwrite an existing version in place (delete + republish). Useful for fast iteration on a single version number. It replaces versions in the default namespace only. 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
Present only when
?auto_build=true. building while the build is queued or running, ready when a golden snapshot for this exact content already exists. Absent when no build could be started. Read build.error for the reason, then call Build template.Present only when
?auto_build=true. What happened to the requested build. The publish itself has succeeded either way.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
Query Parameters
Body
The orgo.ai/v1 template document as YAML.
Response
Published