Skip to content

by Startups.Studio

OverviewTemplate

Template.upgrade

POST /{namespace}/templates/{template}/upgrade

Upgrade moves a Startup to a newer Version of a Template it extends, through a Change it can review.

Noun: Template
Mode: do
Event: Template.upgraded

You, to your agent

Upgrade the latest template with a startup.

curl -X POST https://api.sb/petpantry.shop/templates/template_1/upgrade \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_1"}'

import { $ } from 'startup-builder'

const { change, template } = await $.Template.upgrade({ template: 'template_1', startup: 'startup_1' })

npx startup-builder do Template.upgrade --json '{"template":"template_1","startup":"startup_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Template.upgrade({ template: 'template_1', startup: 'startup_1' })"
  }
}

Inputs

Input	Type	Required	Description
`template`	Template	required	The Template to upgrade.
`startup`	Startup	required	The Startup that extends it.
`version`	Version		The target Version. Defaults to the latest.

Outputs

Output	Type	Required	Description
`change`	Change	required	The Change that moves the pin.
`template`	Template	required	The Template upgraded to.

Effects

Emits Template.upgraded.
Opens a Change; nothing moves until it merges.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Template.upgrade
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Template.upgrade

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.