Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

@sms/model-openrouter

Interfaces

OpenRouterModelOptions

Defined in: packages/drivers/model/openrouter/src/index.ts:37

Properties

apiKey?
optional apiKey?: string;

Defined in: packages/drivers/model/openrouter/src/index.ts:39

Default: OPENROUTER_API_KEY from the environment (Node). In a Worker pass env.OPENROUTER_API_KEY.

appName?
optional appName?: string;

Defined in: packages/drivers/model/openrouter/src/index.ts:49

Sent as X-Title — shows your app on openrouter.ai rankings.

baseURL?
optional baseURL?: string;

Defined in: packages/drivers/model/openrouter/src/index.ts:47

Default: ‘https://openrouter.ai/api/v1’.

client?
optional client?: Pick<OpenAI, "chat">;

Defined in: packages/drivers/model/openrouter/src/index.ts:55

Bring your own client (anything exposing chat.completions.create).

debug?
optional debug?: (...args) => void;

Defined in: packages/drivers/model/openrouter/src/index.ts:56

Parameters
ParameterType
argsunknown[]
Returns

void

effort?
optional effort?: "low" | "medium" | "high" | "xhigh" | "max" | "minimal" | "none";

Defined in: packages/drivers/model/openrouter/src/index.ts:45

OpenRouter’s unified reasoning.effort (ignored by models without reasoning).

fetch?
optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Defined in: packages/drivers/model/openrouter/src/index.ts:53

Inject a fetch (tests, proxies).

Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
ParameterType
inputRequestInfo | URL
init?RequestInit
Returns

Promise<Response>

Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
ParameterType
inputstring | Request | URL
init?RequestInit
Returns

Promise<Response>

maxOutputTokens?
optional maxOutputTokens?: number;

Defined in: packages/drivers/model/openrouter/src/index.ts:43

Default: 16000.

model?
optional model?: string;

Defined in: packages/drivers/model/openrouter/src/index.ts:41

OpenRouter model slug. Default: ‘anthropic/claude-sonnet-4.5’.

siteUrl?
optional siteUrl?: string;

Defined in: packages/drivers/model/openrouter/src/index.ts:51

Sent as HTTP-Referer (same purpose).

Functions

createOpenRouterModel()

function createOpenRouterModel(opts?): ModelService;

Defined in: packages/drivers/model/openrouter/src/index.ts:297

Parameters

ParameterType
optsOpenRouterModelOptions

Returns

ModelService


openRouterModelPlugin()

function openRouterModelPlugin(opts?): SystemPlugin;

Defined in: packages/drivers/model/openrouter/src/index.ts:302

createOpenRouterModel wrapped as the system plugin that provides model.

Parameters

ParameterType
optsOpenRouterModelOptions

Returns

SystemPlugin