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

npm install @anthropic-ai/vertex-sdk

Usage

import { AnthropicVertex } from '@anthropic-ai/vertex-sdk';

// Reads from the `CLOUD_ML_REGION` & `ANTHROPIC_VERTEX_PROJECT_ID` environment variables.
// Additionally goes through the standard `google-auth-library` flow.
const client = new AnthropicVertex();

async function main() {
  const result = await client.messages.create({
    messages: [
      {
        role: 'user',
        content: 'Hey Claude!',
      },
    ],
    model: 'claude-3-5-sonnet-v2@20241022',
    max_tokens: 300,
  });
  console.log(JSON.stringify(result, null, 2));
}

main();

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.

Changelog

0.7.0 (2025-02-24)

Full Changelog: vertex-sdk-v0.6.4...vertex-sdk-v0.7.0

Features

• api: add claude-3.7 + support for thinking (ffab311)

0.6.4 (2025-01-23)

Full Changelog: vertex-sdk-v0.6.3...vertex-sdk-v0.6.4

Chores

• vertex: bump dependency on @anthropic-ai/sdk (a1c7fcd)

0.6.3 (2025-01-21)

Full Changelog: vertex-sdk-v0.6.2...vertex-sdk-v0.6.3

Bug Fixes

• vertex: add beta.messages.countTokens method (51d3f23)

Chores

• internal: temporary revert commit (#643) (43dd43c)

0.6.2 (2024-12-20)

Full Changelog: vertex-sdk-v0.6.1...vertex-sdk-v0.6.2

Chores

• internal: temporary revert commit (#643) (8057b1e)

0.6.1 (2024-12-17)

Full Changelog: vertex-sdk-v0.6.0...vertex-sdk-v0.6.1

Bug Fixes

• vertex: remove anthropic_version deletion for token counting (88221be)

0.6.0 (2024-12-17)

Full Changelog: vertex-sdk-v0.5.2...vertex-sdk-v0.6.0

Features

• api: general availability updates (#631) (b5c92e5)
• vertex: support token counting (9e76b4d)

Chores

• bedrock,vertex: remove unsupported countTokens method (#597) (17b7da5)

Documentation

• use latest sonnet in example snippets (#625) (f70882b)

0.5.2 (2024-11-05)

Full Changelog: vertex-sdk-v0.5.1...vertex-sdk-v0.5.2

Bug Fixes

• vertex: don't mutate request body inputs (e9a82e5)

0.5.1 (2024-10-23)

Full Changelog: vertex-sdk-v0.5.0...vertex-sdk-v0.5.1

Bug Fixes

• vertex: correct messages beta handling (26f21ee)

0.5.0 (2024-10-22)

Full Changelog: vertex-sdk-v0.4.3...vertex-sdk-v0.5.0

Features

• vertex: add beta.messages.create() (22cfdba)

0.4.3 (2024-10-08)

Full Changelog: vertex-sdk-v0.4.2...vertex-sdk-v0.4.3

Refactors

• types: improve metadata type names (#547) (cef499c)

0.4.2 (2024-10-04)

Full Changelog: vertex-sdk-v0.4.1...vertex-sdk-v0.4.2

Chores

• better object fallback behaviour for casting errors (#526) (4ffb2e4)

0.4.1 (2024-07-29)

Full Changelog: vertex-sdk-v0.4.0...vertex-sdk-v0.4.1

Chores

• internal: remove old reference to check-test-server (8dc9afc)

0.4.0 (2024-05-30)

Full Changelog: vertex-sdk-v0.3.7...vertex-sdk-v0.4.0

Features

• vertex: support tools (acf0aa7)

0.3.7 (2024-05-16)

Full Changelog: vertex-sdk-v0.3.6...vertex-sdk-v0.3.7

Chores

• internal: fix generated version numbers (#413) (ea77063)

0.3.6 (2024-05-07)

Full Changelog: vertex-sdk-v0.3.5...vertex-sdk-v0.3.6

Chores

• internal: refactor scripts (#404) (f60e2d8)

0.3.5 (2024-04-10)

Full Changelog: vertex-sdk-v0.3.4...vertex-sdk-v0.3.5

Bug Fixes

• vertex: correct core client dependency constraint (#384) (de29699)

0.3.4 (2024-04-09)

Full Changelog: vertex-sdk-v0.3.3...vertex-sdk-v0.3.4

Chores

• internal: update lock files (#377) (6d239ef)

0.3.3 (2024-04-04)

Full Changelog: vertex-sdk-v0.3.2...vertex-sdk-v0.3.3

Documentation

• readme: mention tool use (#375) (72356dd)

0.3.2 (2024-04-04)

Full Changelog: vertex-sdk-v0.3.1...vertex-sdk-v0.3.2

Bug Fixes

• types: correctly mark type as a required property in requests (#371) (a04edd8)

0.3.1 (2024-04-04)

Full Changelog: vertex-sdk-v0.3.0...vertex-sdk-v0.3.1

Chores

• deps: remove unused dependency digest-fetch (#368) (df1df0f)

0.3.0 (2024-03-19)

Full Changelog: vertex-sdk-v0.2.2...vertex-sdk-v0.3.0

Features

• vertex: add support for overriding google auth (#338) (28d98c4)
• vertex: api is no longer in private beta (#344) (892127c)

0.2.2 (2024-03-13)

Full Changelog: vertex-sdk-v0.2.1...vertex-sdk-v0.2.2

Documentation

• update models in vertex examples (#331) (3d139b3)

0.2.1 (2024-03-06)

Full Changelog: vertex-sdk-v0.2.0...vertex-sdk-v0.2.1

Documentation

• remove extraneous --save and yarn install instructions (#323) (775ecb9)

0.2.0 (2024-02-13)

Full Changelog: vertex-sdk-v0.1.2...vertex-sdk-v0.2.0

⚠ BREAKING CHANGES

• api: messages is generally available (#287)

Features

• api: messages is generally available (#287) (be0a828)

0.1.2 (2024-01-31)

Full Changelog: vertex-sdk-v0.1.1...vertex-sdk-v0.1.2

Chores

• release main (e77e068)

0.1.1 (2024-01-25)

Full Changelog: vertex-sdk-v0.1.0...vertex-sdk-v0.1.1

Chores

• internal: don't re-export streaming type (#267) (bcae5a9)
• internal: update release-please config (#269) (80952e6)

0.1.0 (2024-01-23)

Full Changelog: vertex-sdk-v0.0.1...vertex-sdk-v0.1.0

Features

• vertex: add support for google vertex (#265) (9a0410d)