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-claude-api

Interfaces

ClaudeApiModelOptions

Defined in: packages/drivers/model/claude-api/src/index.ts:24

Properties

apiKey?
optional apiKey?: string;

Defined in: packages/drivers/model/claude-api/src/index.ts:26

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

baseURL?
optional baseURL?: string;

Defined in: packages/drivers/model/claude-api/src/index.ts:33

client?
optional client?: Pick<Anthropic, "messages">;

Defined in: packages/drivers/model/claude-api/src/index.ts:37

Bring your own client (Bedrock/Vertex/Foundry clients expose the same messages.create).

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

Defined in: packages/drivers/model/claude-api/src/index.ts:38

Parameters
ParameterType
argsunknown[]
Returns

void

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

Defined in: packages/drivers/model/claude-api/src/index.ts:32

output_config.effort; the API default is ‘high’.

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

Defined in: packages/drivers/model/claude-api/src/index.ts:35

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>

maxTokens?
optional maxTokens?: number;

Defined in: packages/drivers/model/claude-api/src/index.ts:30

Default: 16000.

model?
optional model?: string;

Defined in: packages/drivers/model/claude-api/src/index.ts:28

Default: ‘claude-opus-5’.

Functions

claudeApiModelPlugin()

function claudeApiModelPlugin(opts?): SystemPlugin;

Defined in: packages/drivers/model/claude-api/src/index.ts:141

createClaudeApiModel wrapped as the system plugin that provides model.

Parameters

ParameterType
optsClaudeApiModelOptions

Returns

SystemPlugin


createClaudeApiModel()

function createClaudeApiModel(opts?): ModelService;

Defined in: packages/drivers/model/claude-api/src/index.ts:136

Parameters

ParameterType
optsClaudeApiModelOptions

Returns

ModelService