Skip to main content

Class: AgentPausedError

Defined in: packages/orchestration/src/errors.ts:23

Thrown by an agent when it needs external input before continuing.

When a tool (e.g., ask_distlr) determines the agent cannot proceed without user input, it throws this error. The RunManager catches it, serializes the agent's conversation history, marks the run as 'paused', and emits a 'run.paused' event.

The run can later be resumed via RunManager.resumeRun(runId, answer), which restores the agent's history and continues execution.

Example​

// Inside a tool handler:
throw new AgentPausedError(
  'Should I include individual line item prices or just totals?',
  { section: 'Line Items', fieldCount: 6 }
);

Extends​

  • BaleybotError

Constructors​

Constructor​

new AgentPausedError(question, context?): AgentPausedError

Defined in: packages/orchestration/src/errors.ts:27

Parameters​

question​

string

context?​

Record<string, unknown>

Returns​

AgentPausedError

Overrides​

BaleybotError.constructor

Properties​

cause?​

optional cause?: unknown

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

BaleybotError.cause

code​

readonly code: string

Defined in: packages/core/dist/types/errors.d.ts:6

Inherited from​

BaleybotError.code

context?​

readonly optional context?: Record<string, unknown>

Defined in: packages/orchestration/src/errors.ts:25

message​

message: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

BaleybotError.message

name​

name: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

BaleybotError.name

question​

readonly question: string

Defined in: packages/orchestration/src/errors.ts:24

stack?​

optional stack?: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

BaleybotError.stack

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

BaleybotError.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

BaleybotError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

BaleybotError.prepareStackTrace