Class AnthropicClient

Anthropic API client.

Example

const client = new AnthropicClient({
  apiKey: process.env.API_KEY_ANTHROPIC!,
  defaultModel: 'claude-sonnet-4-20250514',
});

// Message
const response = await client.message([
  { role: 'user', content: 'Hello!' }
]);

// Stream
for await (const delta of client.streamContent([
  { role: 'user', content: 'Tell me a story' }
])) {
  process.stdout.write(delta.text);
}

// Simple
const text = await client.messageSimple([
  { role: 'user', content: 'Say hi!' }
]);

Index

Constructors

constructor

new AnthropicClient(config: AnthropicClientConfig): AnthropicClient
Parameters
- config: AnthropicClientConfig
Returns AnthropicClient
- Defined in providers/anthropic/client.ts:87

Properties

extractText

extractText: (content: ResponseContentBlock[]) => string = extractText

Extract text from response content blocks.

Type Declaration

- (content: ResponseContentBlock[]): string
- Extract text content from response content blocks.
  Parameters
  - content: ResponseContentBlock[]
  Returns string

extractToolUses

extractToolUses: (content: ResponseContentBlock[]) => ToolUseBlock[] = extractToolUses

Extract tool uses from response content blocks.

Type Declaration

- (content: ResponseContentBlock[]): ToolUseBlock[]
- Extract tool uses from response content blocks.
  Parameters
  - content: ResponseContentBlock[]
  Returns ToolUseBlock[]

Methods

message

message(
messages: Message[],
options?: Partial<MessagesOptions>,
): Promise<MessagesResponse>
Create a message.
Parameters
- messages: Message[]
- Optionaloptions: Partial<MessagesOptions>
Returns Promise<MessagesResponse>
- Defined in providers/anthropic/client.ts:127

messageSimple

messageSimple(
messages: Message[],
options?: Partial<MessagesOptions>,
): Promise<string>
Create a message and return just the text content.
Parameters
- messages: Message[]
- Optionaloptions: Partial<MessagesOptions>
Returns Promise<string>
- Defined in providers/anthropic/client.ts:137

messageWithTools

messageWithTools(
    messages: Message[],
    tools: AnyTool[],
    options?: Partial<MessagesOptions>,
): Promise<
    | { type: "text"; text: string; usage: Usage }
    | { type: "tool_use"; toolUses: ToolUseBlock[]; usage: Usage },
>
Message with tool handling.
Parameters
- messages: Message[]
- tools: AnyTool[]
- Optionaloptions: Partial<MessagesOptions>
Returns Promise<
| { type: "text"; text: string; usage: Usage }
| { type: "tool_use"; toolUses: ToolUseBlock[]; usage: Usage },
>
- Defined in providers/anthropic/client.ts:144

messageStructured

messageStructured<T>(
    messages: Message[],
    schema: {
        name: string;
        description?: string;
        schema: Record<string, unknown>;
    },
    options?: Partial<MessagesOptions>,
): Promise<T>
Message with structured output.
Type Parameters
- T
Parameters
- messages: Message[]
- schema: { name: string; description?: string; schema: Record<string, unknown> }
- Optionaloptions: Partial<MessagesOptions>
Returns Promise<T>
- Defined in providers/anthropic/client.ts:161

stream

stream(
messages: Message[],
options?: Partial<MessagesStreamOptions>,
): AsyncGenerator<StreamEvent, void, undefined>
Stream message events.
Parameters
- messages: Message[]
- Optionaloptions: Partial<MessagesStreamOptions>
Returns AsyncGenerator<StreamEvent, void, undefined>
- Defined in providers/anthropic/client.ts:180

streamContent

streamContent(
messages: Message[],
options?: Partial<MessagesStreamOptions>,
): AsyncGenerator<StreamDelta, void, undefined>
Stream content deltas.
Parameters
- messages: Message[]
- Optionaloptions: Partial<MessagesStreamOptions>
Returns AsyncGenerator<StreamDelta, void, undefined>
- Defined in providers/anthropic/client.ts:195

streamAccumulate

streamAccumulate(
    messages: Message[],
    options?: Partial<MessagesStreamOptions>,
    onDelta?: (delta: string) => void,
): Promise<
    {
        content: string;
        thinking: string;
        toolUses: ToolUseBlock[];
        stopReason: string
        | null;
        usage: Usage | null;
        model: string;
        id: string;
    },
>
Stream and accumulate full response.
Parameters
- messages: Message[]
- Optionaloptions: Partial<MessagesStreamOptions>
- OptionalonDelta: (delta: string) => void
Returns Promise<
    {
        content: string;
        thinking: string;
        toolUses: ToolUseBlock[];
        stopReason: string
        | null;
        usage: Usage | null;
        model: string;
        id: string;
    },
>
- Defined in providers/anthropic/client.ts:207

streamReadable

streamReadable(
messages: Message[],
options?: Partial<MessagesStreamOptions>,
): ReadableStream<string>
Create a readable stream of content.
Parameters
- messages: Message[]
- Optionaloptions: Partial<MessagesStreamOptions>
Returns ReadableStream<string>
- Defined in providers/anthropic/client.ts:227

Class AnthropicClient

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AnthropicClient

Properties

extractText

Type Declaration

Parameters

Returns string

extractToolUses

Type Declaration

Parameters

Returns ToolUseBlock[]

Methods

message

Parameters

Returns Promise<MessagesResponse>

messageSimple

Parameters

Returns Promise<string>

messageWithTools

Parameters

Returns Promise< | { type: "text"; text: string; usage: Usage } | { type: "tool_use"; toolUses: ToolUseBlock[]; usage: Usage },>

messageStructured

Type Parameters

Parameters

Returns Promise<T>

stream

Parameters

Returns AsyncGenerator<StreamEvent, void, undefined>

streamContent

Parameters

Returns AsyncGenerator<StreamDelta, void, undefined>

streamAccumulate

Parameters

Returns Promise< { content: string; thinking: string; toolUses: ToolUseBlock[]; stopReason: string | null; usage: Usage | null; model: string; id: string; },>

streamReadable

Parameters

Returns ReadableStream<string>

Settings

On This Page

Returns Promise<
| { type: "text"; text: string; usage: Usage }
| { type: "tool_use"; toolUses: ToolUseBlock[]; usage: Usage },
>

Returns Promise<
{
content: string;
thinking: string;
toolUses: ToolUseBlock[];
stopReason: string
| null;
usage: Usage | null;
model: string;
id: string;
},
>