Class: ServiceUnavailableError

@kortexya/reasoninglayer / ServiceUnavailableError

Class: ServiceUnavailableError

Defined in: src/errors.ts:763

Service unavailable error (HTTP 503).

Remarks

The engine answers 503 when a route depends on a component this deployment has not configured — for example the long-term memory port behind client.memory, an embedding backend, or a speech sidecar. It is a documented deployment state, not a crash: branch on this type instead of matching the message. The body’s message names what is missing (for example "memory port not configured").

Extends InternalServerError, so an existing instanceof InternalServerError check keeps catching every 5xx. A 503 is retried only when retryOn503 is set in the client configuration.

Example

try {
  await client.memory.recall({ query: 'standup' });
} catch (error) {
  if (error instanceof ServiceUnavailableError) {
    // Memory is not configured on this deployment: hide the feature.
  }
}

Extends

InternalServerError

Constructors

Constructor

new ServiceUnavailableError(message, body, headers, errorCode?): ServiceUnavailableError

Defined in: src/errors.ts:766

Parameters

message

string

body

unknown

headers

Headers

errorCode?

string

Returns

ServiceUnavailableError

Overrides

InternalServerError.constructor

Properties

body

readonly body: unknown

Defined in: src/errors.ts:55

Parsed response body.

Inherited from

InternalServerError.body

cause?

optional cause?: unknown

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

Inherited from

InternalServerError.cause

errorCode

readonly errorCode: string | undefined

Defined in: src/errors.ts:53

Backend error code (from response body error field), if present.

Inherited from

InternalServerError.errorCode

headers

readonly headers: Headers

Defined in: src/errors.ts:57

Response headers.

Inherited from

InternalServerError.headers

message

message: string

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

Inherited from

InternalServerError.message

name

name: string = 'ServiceUnavailableError'

Defined in: src/errors.ts:764

Overrides

InternalServerError.name

stack?

optional stack?: string

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

Inherited from

InternalServerError.stack

status

readonly status: number

Defined in: src/errors.ts:51

HTTP status code.

Inherited from

InternalServerError.status

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@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

InternalServerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@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

InternalServerError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@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

InternalServerError.prepareStackTrace