Skip to content

by startups.studio

by Startups.Studio

Agent.upgrade

POST /{namespace}/agents/{agent}/upgrade

Upgrade moves a Customer’s minted Agent to a new Version once every case in its Tenant passes on that Version.

Noun: Agent
Mode: do
Event: Agent.upgraded

You, to your agent

Upgrade the latest agent with a version.

curl -X POST https://api.sb/leaseline.app/agents/agent_tCzKDMorKn/upgrade \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"version":"version_4HTEMs14G4"}'

npx startup-builder do Agent.upgrade --data '{"agent":"agent_tCzKDMorKn","version":"version_4HTEMs14G4"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agent.upgrade({ agent: 'agent_tCzKDMorKn', version: 'version_4HTEMs14G4' })"
  }
}

import { $ } from 'startup-builder'

const agent = await $.Agent.upgrade({ agent: 'agent_tCzKDMorKn', version: 'version_4HTEMs14G4' })

Inputs

Input	Type	Required	Description
`agent`	Agent	required	The minted Agent.
`version`	Version	required	The target Version.

Outputs

Output	Type	Required	Description
`agent`	Agent	required	The Agent, on the target Version.

Effects

Fact	Value
Action class	None: no approval rule names it, so it runs within its seat's Permissions and Limits
Stakes	Who may act
Door	Two-way: it runs at once
Modes	`try` previews it and stores nothing; `send` returns a pending Action; `do` (default) waits for the result
Idempotent	Only with a key: a repeat with the same `Idempotency-Key` and input returns the first Action, the same key with other input is refused with `409`, and a repeat without a key runs again
Undo	Action.undo reverses it
Emits	`Agent.upgraded`
Performed by	The Engineering Lead

Replays every case recorded in the Customer’s Tenant on the target Version first; a failing case leaves the Agent where it was and names the case.

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.	None.
`agent` is missing, or is not a agent	`invalid-input`	Send `agent` as a agent, then call it again.	None.
`version` is missing, or is not a version	`invalid-input`	Send `version` as a version, then call it again.	None.
The `Idempotency-Key` was sent before with another operation or other input	`idempotency-mismatch`	Send a new key for new input; reuse a key only to retry the same request.	None.

When it waits

Gate	Default
Decision class	Low: two-way, no delay window
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, which a Human answers: the owner of record, or a Human they named to approve for the Founder seat. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

To retry, send the same Idempotency-Key: the retry returns the first Action and runs nothing twice. A new key runs the call again.

Agent.update

Previous

Candidate

Next