Agent methods: mint, pause, resume, retire
The Agent Verbs mint, pause, resume, retire as typed SDK methods, with inputs, result, refusals and an example.
Reference for Agent, one group of Agent methods.
Agent.mint
Mint creates an Agent in a Customer’s Tenant from an Agent Product the Customer bought. Verb page.
interface AgentVerbs {
mint(input: AgentMintInput, options?: SB.CallOptions): SB.Call<Agent>
}Emits Agent.minted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
tenant | Tenant | required | The Customer’s Tenant. |
product | Product | required | The Agent Product. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
agent | Agent | required | The Customer’s own Agent. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The operation is part of an Offer the caller has not accepted or paid for. | payment-required | Accept the Offer named in the response, then retry the call. | Offer.accept |
| 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. |
Example
import { $ } from 'startup-builder'
const agent = await $.Agent.mint({ tenant: 'ten_Bu63f0he26', product: 'prod_MJmgS5dysq' })Agent.pause
Pause stops one Agent, every Agent on a Team, or every customer-facing Agent from starting new Actions in a Startup. Verb page.
interface AgentVerbs {
pause(input: AgentPauseInput, options?: SB.CallOptions): SB.Call<Agent[]>
}Emits Agent.paused.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
agents | list of Agent | The Agents to pause. Name one of agents, team or customerFacing. | |
team | Team | Pause every Agent seated on this Team. | |
customerFacing | boolean | True pauses every Agent seated in a Role that answers a customer Channel. | |
reason | text | required | Why the Agents stop, shown to every watcher. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
agents | list of Agent | required | Every Agent it paused; each emits its own Agent.paused. |
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. |
Example
import { $ } from 'startup-builder'
const agents = await $.Agent.pause({ agents: ['agent_tCzKDMorKn'], reason: 'Example reason' })Agent.resume
Resume restarts a paused Agent in every seat it holds, with its Memory, Mandates and Limits unchanged. Verb page.
interface AgentVerbs {
resume(input: AgentResumeInput, options?: SB.CallOptions): SB.Call<Agent>
}Emits Agent.resumed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
agent | Agent | required | The paused Agent. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
agent | Agent | required | The working Agent. |
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. |
Example
import { $ } from 'startup-builder'
const agent = await $.Agent.resume({ agent: 'agent_tCzKDMorKn' })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. Verb page.
interface AgentVerbs {
retire(input: AgentRetireInput, options?: SB.CallOptions): SB.Call<Agent>
}Emits Agent.retired.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
agent | Agent | required | The Agent to retire. |
reason | text | required | Why it leaves. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
agent | Agent | required | The retired Agent. |
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. |
Example
import { $ } from 'startup-builder'
const agent = await $.Agent.retire({ agent: 'agent_tCzKDMorKn', reason: 'Example reason' })