Agent methods: update, delete

Reference for Agent, one group of Agent methods.

Agent.update

Changes the given properties of an Agent. Verb page.

TypeScript

interface AgentVerbs {
  update(input: AgentUpdateInput, options?: SB.CallOptions): SB.Call<Agent>
}

Emits Agent.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Agent.
`instructions`	`text`		What the Agent does and how.
`model`	`string`		The model the Agent runs on.
`tools`	`string[]`		The tools the Agent may call.
`skills`	list of Skill		The Skills it loads.
`memory`	`string`		One of `tenant` (one Memory per Customer Tenant) or `startup` (one Memory for the Startup).
`maxSteps`	`integer`		The most steps one Task may take.
`budget`	`money`		The most one Task may spend; the Mandate’s Limits apply as well.
`handoffs`	list of Role		The Roles it hands work to.

Returns

Output	Type	Required	Description
`agent`	Agent	required	The 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

TypeScript

import { $ } from 'startup-builder'

const agent = await $.Agent.update({ id: 'agent_tCzKDMorKn', skills: ['skill_xBqG4zTxBA'] })

Deletes an Agent: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface AgentVerbs {
  delete(input: AgentDeleteInput, options?: SB.CallOptions): SB.Call<Agent>
}

Emits Agent.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Agent.

Returns

Output	Type	Required	Description
`agent`	Agent	required	The 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

TypeScript

import { $ } from 'startup-builder'

const agent = await $.Agent.delete({ id: 'agent_tCzKDMorKn' })