Skip to content

by Startups.Studio

Agent.pause

POST /{namespace}/agents/pause

Pause stops one Agent, every Agent on a Team, or every customer-facing Agent from starting new Actions in a Startup.

Noun: Agent
Mode: do
Event: Agent.paused

You, to your agent

Pause the latest agent.

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

import { $ } from 'startup-builder'

const agents = await $.Agent.pause({ agents: ['agent_1'], reason: 'Example reason' })

npx startup-builder do Agent.pause --json '{"agents":["agent_1"],"reason":"Example reason"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agent.pause({ agents: ['agent_1'], reason: 'Example reason' })"
  }
}

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.

Outputs

Output	Type	Required	Description
`agents`	list of Agent	required	Every Agent it paused; each emits its own `Agent.paused`.

Effects

Emits Agent.paused.
Performed by the Founder.
Two-way: it runs at once, in the try, send and do modes.
Holds every pending Action the Agent started; running Actions finish.
Keeps new Tasks in each seat’s queue, and sends each customer who writes a holding reply from the Role address.
Leaves Memory, Mandates and Limits untouched, so resume picks up where it stopped.

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.pause

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
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 from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Agent.mint

Previous Page

Agent.resume

Next Page