Anthropic Vertex TypeScript API Library

This library provides convenient access to the Anthropic Vertex API.

For the non-Vertex Anthropic API at api.anthropic.com, see @anthropic-ai/sdk.

Installation

1npm install @anthropic-ai/vertex-sdk

Usage

1import { AnthropicVertex } from '@anthropic-ai/vertex-sdk';
2
3// Reads from the `CLOUD_ML_REGION` & `ANTHROPIC_VERTEX_PROJECT_ID` environment variables.
4// Additionally goes through the standard `google-auth-library` flow.
5const client = new AnthropicVertex();
6
7async function main() {
8  const result = await client.messages.create({
9    messages: [
10      {
11        role: 'user',
12        content: 'Hey Claude!',
13      },
14    ],
15    model: 'claude-3-5-sonnet-v2@20241022',
16    max_tokens: 300,
17  });
18  console.log(JSON.stringify(result, null, 2));
19}
20
21main();

For more details on how to use the SDK, see the README.md for the main Anthropic SDK which this library extends.

Requirements

TypeScript >= 4.5 is supported.

The following runtimes are supported:

• Node.js 18 LTS or later (non-EOL) versions.
• Deno v1.28.0 or higher, using import { AnthropicVertex } from "npm:@anthropic-ai/vertex-sdk".
• Bun 1.0 or later.
• Cloudflare Workers.
• Vercel Edge Runtime.
• Jest 28 or greater with the "node" environment ("jsdom" is not supported at this time).
• Nitro v2.6 or greater.

Note that React Native is not supported at this time.

If you are interested in other runtime environments, please open or upvote an issue on GitHub.