Skip to content

by Startups.Studio

Agent.retire

POST /{namespace}/agents/{agent}/retire

Retire removes an Agent from every seat in a Startup for good and keeps its Actions, Memory and Mailbox history on the record.

Noun: Agent
Mode: do
Event: Agent.retired

You, to your agent

Retire the latest agent.

curl -X POST https://api.sb/quietcopy.com/agents/agent_1/retire \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'

import { $ } from 'startup-builder'

const agent = await $.Agent.retire({ agent: 'agent_1', reason: 'Example reason' })

npx startup-builder do Agent.retire --json '{"agent":"agent_1","reason":"Example reason"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agent.retire({ agent: 'agent_1', reason: 'Example reason' })"
  }
}

Inputs

Input	Type	Required	Description
`agent`	Agent	required	The Agent to retire.
`reason`	`text`	required	Why it leaves.

Outputs

Output	Type	Required	Description
`agent`	Agent	required	The retired Agent.

Effects

Emits Agent.retired.
Performed by the People Lead.
One-way (customer): it waits out its delay window, and runs in the send and do modes.
Vacates every Role the Agent held, so each seat’s Tasks route to the Role it escalates to.
Ends its Mandates and Permissions in this Startup.

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

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (customer)
Delay window	1 business hour, 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`.

Agent.resume

Previous Page

Agent.update

Next Page