@cleverrouter/sdk

Classes

CleverRouter

Defined in: packages/sdk/src/index.ts:212

Constructors

Constructor

new CleverRouter(config): CleverRouter;

Defined in: packages/sdk/src/index.ts:226

Parameters

Returns

CleverRouter

Properties

Accessors

batches

Get Signature

get batches(): object;

Defined in: packages/sdk/src/index.ts:646

Batches-Namespace — Async-Batch-Inference. JSONL-Input via files.create(), dann hier batches.create() aufrufen. getOutput() ist ein AsyncIterable pro JSONL-Zeile.

Example

const batch = await cr.batches.create({
  input_file_id: f.id,
  endpoint: '/v1/chat/completions',
  completion_window: '24h',
});
for await (const row of cr.batches.getOutput(batch.id)) {
  console.log(row.custom_id, row.response?.body);
}

Returns

files

Get Signature

get files(): object;

Defined in: packages/sdk/src/index.ts:582

Files-Namespace — Upload/Download/Delete fuer Batch-Inference-Inputs.

Example

const f = await cr.files.create({ name: 'in.jsonl', type: 'application/jsonl', data: jsonlBuffer });
const batch = await cr.batches.create({ input_file_id: f.id, endpoint: '/v1/chat/completions' });

Returns

object

webhooks

Get Signature

get webhooks(): object;

Defined in: packages/sdk/src/index.ts:710

Webhooks-Namespace — Stripe-Style Webhook-Registry fuer Batch-Events.

Example

const hook = await cr.webhooks.create({ url: 'https://app.example/hook', events: ['batch.completed'] });
console.log(hook.secret); // einmalig — sicher speichern

Returns

object

Methods

chat()

chat(req, opts?): Promise<ChatCompletionResponse>;

Defined in: packages/sdk/src/index.ts:402

Chat-Completion (non-stream) via direkten Gateway-Call. Fuer Tools+Vision+Reasoning weiterhin cr.openai() empfohlen, dieser Helper ist fuer typed Quickshots ohne OpenAI-SDK-Dependency.

Parameters

Returns

Promise<ChatCompletionResponse>

Vollstaendige Chat-Completion-Response.

Throws

Subtypen je nach Gateway-Status.

Example

const res = await cr.chat({
  model: 'mistral/mistral-small-3.2',
  messages: [{ role: 'user', content: 'Hi.' }],
});
console.log(res.choices[0].message.content);

embed()

embed(input, opts?): Promise<EmbeddingResponse>;

Defined in: packages/sdk/src/index.ts:471

Typed Embedding-Call. Default-Model: cohere/embed-v4.

Parameters

Returns

Promise<EmbeddingResponse>

Embedding-Response (Vektor pro Input).

Throws

Subtypen je nach Gateway-Status.

Example

const res = await cr.embed(['hello', 'world'], {
  model: 'cohere/embed-v4',
  encoding_format: 'float',
});

headers()

headers(opts?): Record<string, string>;

Defined in: packages/sdk/src/index.ts:329

Headers für einen einzelnen Request (Provider-Pin, Strategy).

Parameters

Returns

Record<string, string>

listModels()

listModels(opts?): Promise<ModelInfo[]>;

Defined in: packages/sdk/src/index.ts:360

Holt das Live-Modell-Verzeichnis vom Gateway.

Parameters

Returns

Promise<ModelInfo[]>

Liste der verfuegbaren Modelle.

Throws

401 — Key fehlt/ungueltig.

Throws

429 — Rate-Limit ueberschritten.

Throws

502/503 — Gateway oder Upstream down.

Throws

408 — Client-Timeout.

Example

const embeddings = await cr.listModels({ kind: 'embedding' });
console.log(embeddings.map((m) => m.id));

model()

model<M>(id): M;

Defined in: packages/sdk/src/index.ts:302

Typed Modell-Liste — gibt einen string zurueck, der vom Gateway erkannt wird.

Type Parameters

Parameters

Returns

M

modelsByClass()

modelsByClass(klass): readonly CleverRouterModel[];

Defined in: packages/sdk/src/index.ts:324

Liefert alle Modelle einer Klasse als Liste.

Parameters

Returns

readonly CleverRouterModel[]

openai()

openai(overrides?): OpenAI;

Defined in: packages/sdk/src/index.ts:284

Erzeugt einen OpenAI-SDK-Client der gegen CleverRouter spricht. Provider-Pin und Strategy aus der Client-Config werden als defaultHeaders durchgereicht; pro Call ueberschreibbar via overrides.

Parameters

Returns

OpenAI

Ein vorkonfigurierter OpenAI-Client.

Example

const completion = await cr.openai().chat.completions.create({
  model: 'mistral/mistral-small-3.2',
  messages: [{ role: 'user', content: 'Hi.' }],
});

pickByClass()

pickByClass(klass): CleverRouterModel;

Defined in: packages/sdk/src/index.ts:312

Wahl-Helper fuer Modell-Klassen. Erste Wahl pro Klasse.

Parameters

Returns

CleverRouterModel

Throws

wenn die Klasse unbekannt ist — Message listet die existierenden Klassen.

rerank()

rerank(opts): Promise<RerankResponse>;

Defined in: packages/sdk/src/index.ts:523

Typed Rerank-Call. Default-Model: cohere/rerank-v3-5.

Parameters

Returns

Promise<RerankResponse>

Rerank-Response mit sortierten Indizes + relevance_score.

Throws

400 — query oder documents leer / top_n invalide.

Throws

Andere Gateway-Status.

Example

const res = await cr.rerank({
  query: 'EU GDPR',
  documents: ['a', 'b', 'c'],
  top_n: 2,
});

resetStats()

resetStats(): void;

Defined in: packages/sdk/src/index.ts:786

Setzt die internen Counter zurueck (Tests + Bench-Runs).

Returns

void

stats()

stats(): object;

Defined in: packages/sdk/src/index.ts:775

Aggregierte Counter ueber Cache-Hits/Misses, Total-Calls und ungefaehre gesparte Kosten durch den Embeddings-Cache.

costSaved ist eine Schaetzung (0.05 EUR / 1k tokens, 1 Token ≈ 4 chars). Wenn kein Cache konfiguriert ist, sind cacheHits/cacheMisses = 0.

Returns

object

Example

const cr = createCleverRouter({ apiKey, cache: { embeddings: { ttlSec: 86400 } } });
await cr.embed(['hi', 'hi']);
console.log(cr.stats()); // { cacheHits: 1, cacheMisses: 1, totalRequests: 2, costSaved: 0.000... }

stream()

stream(req, opts?): AsyncIterable<ChatStreamChunk>;

Defined in: packages/sdk/src/index.ts:433

Streaming-Chat — AsyncIterable<ChatStreamChunk> mit Reconnect-on-Drop. Reconnect-Versuche: bis zu 2, mit Last-Event-ID-Header.

Parameters

Returns

AsyncIterable<ChatStreamChunk>

AsyncIterable von Chat-Stream-Chunks.

Throws

Wenn der Initial-Request fehlschlaegt; im Iterator selber bei abruptem EOF.

Example

const stream = cr.stream({
  model: 'mistral/mistral-small-3.2',
  messages: [{ role: 'user', content: 'Stream a haiku.' }],
});
for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content ?? '');
}

transcribe()

transcribe(file, opts?): Promise<TranscriptionResponse>;

Defined in: packages/sdk/src/index.ts:555

Typed Audio-Transcription. Default-Model: systran/faster-whisper-large-v3. Akzeptiert File, Blob oder { name, type, data } mit ArrayBuffer | Uint8Array | Blob.

Parameters

Returns

Promise<TranscriptionResponse>

Transkription je nach response_format (JSON, verbose JSON, plain text).

Throws

Subtypen je nach Gateway-Status.

Example

import { readFileSync } from 'node:fs';
const res = await cr.transcribe(
  { name: 'audio.mp3', type: 'audio/mpeg', data: readFileSync('./audio.mp3') },
  { language: 'en', response_format: 'verbose_json' },
);

CRAuthError

Defined in: packages/sdk/src/errors.ts:29

401 — API-Key ungueltig oder fehlt.

Extends

• CRError

Constructors

Constructor

new CRAuthError(
   message, 
   code?, 
   requestId?): CRAuthError;

Defined in: packages/sdk/src/errors.ts:30

Parameters

Returns

CRAuthError

Overrides

CRError.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@20.19.40/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

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

CRError.captureStackTrace

isError()

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

prepareStackTrace()

Call Signature

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

Call Signature

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

CRBudgetExceededError

Defined in: packages/sdk/src/errors.ts:64

402 — Budget des Workspaces ueberschritten.

Extends

• CRError

Constructors

Constructor

new CRBudgetExceededError(
   message, 
   code?, 
   requestId?): CRBudgetExceededError;

Defined in: packages/sdk/src/errors.ts:65

Parameters

Returns

CRBudgetExceededError

Overrides

CRError.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@20.19.40/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

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

CRError.captureStackTrace

isError()

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

prepareStackTrace()

Call Signature

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

Call Signature

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

CRError

Defined in: packages/sdk/src/errors.ts:9

Basis-Error fuer alle CleverRouter-spezifischen Fehler.

Extends

• Error

Extended by

• CRAuthError
• CRRateLimitError
• CRModelNotFoundError
• CRModelDeprecatedError
• CRBudgetExceededError
• CRProviderDownError
• CRValidationError
• CRTimeoutError

Constructors

Constructor

new CRError(
   message, 
   status, 
   code, 
   requestId?): CRError;

Defined in: packages/sdk/src/errors.ts:14

Parameters

Returns

CRError

Overrides

Error.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@20.19.40/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

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

Error.captureStackTrace

isError()

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

Error.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

Error.isError

prepareStackTrace()

Call Signature

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Returns

any

See

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

Inherited from

Error.prepareStackTrace

Call Signature

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

Error.prepareStackTrace

CRModelDeprecatedError

Defined in: packages/sdk/src/errors.ts:56

410 — Modell wurde deprecated und ist abgeschaltet.

Extends

• CRError

Constructors

Constructor

new CRModelDeprecatedError(
   message, 
   code?, 
   requestId?): CRModelDeprecatedError;

Defined in: packages/sdk/src/errors.ts:57

Parameters

Returns

CRModelDeprecatedError

Overrides

CRError.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@20.19.40/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

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

CRError.captureStackTrace

isError()

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

prepareStackTrace()

Call Signature

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

Call Signature

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

CRModelNotFoundError

Defined in: packages/sdk/src/errors.ts:48

404 — Modell-ID unbekannt.

Extends

• CRError

Constructors

Constructor

new CRModelNotFoundError(
   message, 
   code?, 
   requestId?): CRModelNotFoundError;

Defined in: packages/sdk/src/errors.ts:49

Parameters

Returns

CRModelNotFoundError

Overrides

CRError.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@20.19.40/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

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

CRError.captureStackTrace

isError()

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

CRError.isError

prepareStackTrace()

Call Signature

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

Call Signature

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

CRError.prepareStackTrace

CRProviderDownError

Defined in: packages/sdk/src/errors.ts:72

502/503/504 — Upstream-Provider antwortet nicht oder Gateway-Timeout.

Extends

• CRError

Constructors

Constructor

new CRProviderDownError(
   message, 
   status?, 
   code?, 
   requestId?): CRProviderDownError;

Defined in: packages/sdk/src/errors.ts:73

Parameters

Returns

CRProviderDownError

Overrides

CRError.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@20.19.40/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

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.3.13/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Returns

void

Inherited from

CRError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@25.6.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

CRError.captureStackTrace

isError()

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Returns

value is Error