Skip to content

by startups.studio

by Startups.Studio

Agent.teach

POST /{namespace}/agents/{agent}/teach

Teach adds a rule to a Customer’s own minted Agent that binds only that Customer’s Tenant.

Noun: Agent
Mode: do
Event: Agent.taught

You, to your agent

Teach the latest agent.

curl -X POST https://api.sb/leaseline.app/agents/agent_tCzKDMorKn/teach \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rule":"Example rule","case":"Example case"}'

npx startup-builder do Agent.teach --data '{"agent":"agent_tCzKDMorKn","rule":"Example rule","case":"Example case"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agent.teach({ agent: 'agent_tCzKDMorKn', rule: 'Example rule', case: 'Example case' })"
  }
}

import { $ } from 'startup-builder'

const agent = await $.Agent.teach({ agent: 'agent_tCzKDMorKn', rule: 'Example rule', case: 'Example case' })

Inputs

Input	Type	Required	Description
`agent`	Agent	required	The minted Agent.
`rule`	`text`	required	The rule, in plain words.
`case`	`text`	required	A case the rule must pass, kept with the Tenant’s cases.

Outputs

Output	Type	Required	Description
`agent`	Agent	required	The Agent with the rule.

Effects

Fact	Value
Action class	None: no approval rule names it, so it runs within its seat's Permissions and Limits
Stakes	Customers, 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.taught`
Performed by	The Engineering Lead

Refuses a rule that would widen what the product’s Role contract allows.

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.
A rule that would widen what the product’s Role contract allows	`refused`	Clear what the check names, then call it again.	None.
`agent` is missing, or is not a agent	`invalid-input`	Send `agent` as a agent, then call it again.	None.
`rule` is missing, or is not a text	`invalid-input`	Send `rule` as a text, then call it again.	None.
`case` is missing, or is not a text	`invalid-input`	Send `case` as a text, 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.retire

Previous

Agent.update

Next