Skip to content

by Startups.Studio

Core grammar Verb

Verb.retire

POST /{namespace}/verbs/{verb}/retire

Retire removes a published Verb from new Versions; callers pinned to earlier Versions keep calling it.

Noun: Verb
Mode: do
Event: Verb.retired

You, to your agent

Retire the latest verb.

curl -X POST https://api.sb/kilnbakery.com/verbs/verb_1/retire \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { version, verb } = await $.Verb.retire({ verb: 'verb_1' })

npx startup-builder do Verb.retire --json '{"verb":"verb_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Verb.retire({ verb: 'verb_1' })"
  }
}

Inputs

Input	Type	Required	Description
`verb`	Verb	required	The Verb to retire.

Outputs

Output	Type	Required	Description
`version`	Version	required	The new Version, without the Verb.
`verb`	Verb	required	The Verb, now retired from new Versions.

Effects

Emits Verb.retired.
Performed by the Product Lead.
One-way (customer): it waits out its delay window, and runs in the send and do modes.
Opens a new Version without the Verb through a Change.
Keeps every pinned Version answering it.

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.	Verb.retire

When it waits

Gate	Default
Decision class	High: one-way, broad (customer)
Delay window	1 business day, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Verb.list

Previous Page

Verb.update

Next Page