SPB Git

Repository Public

claude-on-vertex-ai.md 33.0 KB 996 lines markdown

1---2title: Claude on Google Cloud3url: https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai4description: Anthropic's Claude models are available through [Google Cloud's Agent Platform](https://cloud.google.com/vertex-ai).5---67The API for accessing Claude on Google Cloud's Agent Platform is nearly identical to the [Messages API](https://platform.claude.com/docs/en/api/messages/create), with two key differences in request format:89* On Agent Platform, `model` is not passed in the request body. Instead, it is specified in the Google Cloud endpoint URL.10* On Agent Platform, `anthropic_version` is passed in the request body (rather than as a header), and must be set to the value `vertex-2023-10-16`.1112Agent Platform is also supported by Anthropic's official [client SDKs](https://platform.claude.com/docs/en/cli-sdks-libraries/overview). This guide walks you through making a request to Claude on Agent Platform using one of Anthropic's client SDKs.1314Note that this guide assumes you already have a Google Cloud project that is able to use Agent Platform. See [Anthropic Claude models on Agent Platform](https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/partner-models/claude) for more information on the setup required and a full walkthrough.1516## Install an SDK for accessing Agent Platform1718First, install Anthropic's [client SDK](https://platform.claude.com/docs/en/cli-sdks-libraries/overview) for your language of choice.1920<Tabs>21  <Tab title="Python">22    ```bash23    pip install -U "anthropic[vertex]"24    ```25  </Tab>2627  <Tab title="TypeScript">28    ```bash29    npm install @anthropic-ai/vertex-sdk30    ```31  </Tab>3233  <Tab title="C#">34    ```bash35    dotnet add package Anthropic.Vertex36    ```37  </Tab>3839  <Tab title="Go">40    ```bash41    go get github.com/anthropics/anthropic-sdk-go42    ```43  </Tab>4445  <Tab title="Java">46    <CodeGroup exclude="shell, python, typescript, csharp, go, php, ruby">47      ```groovy Gradle48      implementation("com.anthropic:anthropic-java:2.63.0")49      implementation("com.anthropic:anthropic-java-vertex:2.63.0")50      ```5152      ```xml Maven53      <dependency>54          <groupId>com.anthropic</groupId>55          <artifactId>anthropic-java</artifactId>56          <version>2.63.0</version>57      </dependency>58      <dependency>59          <groupId>com.anthropic</groupId>60          <artifactId>anthropic-java-vertex</artifactId>61          <version>2.63.0</version>62      </dependency>63      ```6465      ```java Java66      import com.anthropic.client.AnthropicClient;67      import com.anthropic.client.okhttp.AnthropicOkHttpClient;68      import com.anthropic.models.messages.Message;69      import com.anthropic.models.messages.MessageCreateParams;70      import com.anthropic.models.messages.Model;71      import com.anthropic.vertex.backends.VertexBackend;7273      void main() {74          AnthropicClient client = AnthropicOkHttpClient.builder()75              .backend(VertexBackend.fromEnv())76              .build();7778          MessageCreateParams params = MessageCreateParams.builder()79              .model(Model.CLAUDE_OPUS_5)80              .maxTokens(1024L)81              .addUserMessage("What is the capital of France?")82              .build();8384          Message response = client.messages().create(params);85          response.content().stream()86              .flatMap(block -> block.text().stream())87              .forEach(textBlock -> IO.println(textBlock.text()));88      }89      ```90    </CodeGroup>91  </Tab>9293  <Tab title="PHP">94    ```bash95    composer require anthropic-ai/sdk google/auth96    ```97  </Tab>9899  <Tab title="Ruby">100    ```bash101    # Gemfile102    gem "anthropic"103    gem "googleauth"104    ```105  </Tab>106</Tabs>107108## Accessing Agent Platform109110### Model availability111112Note that Anthropic model availability varies by region. Search for "Claude" in the [Model Garden](https://cloud.google.com/model-garden) or go to [Anthropic Claude models](https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/partner-models/claude) for the latest information.113114#### API model IDs115116Lifecycle terms (Deprecated, Retired) are defined in [Model deprecations](https://platform.claude.com/docs/en/about-claude/model-deprecations). Lifecycle dates on partner-operated platforms are set by the partner and can differ from the Claude API schedule. For the current retirement date of any model on Agent Platform, see [Google Cloud's documentation for Claude models on Agent Platform](https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/partner-models/claude).117118| Model                                                                                                | Agent Platform API model ID  |119| :--------------------------------------------------------------------------------------------------- | :--------------------------- |120| Claude Fable 5.1                                                                                     | `claude-fable-5-1`           |121| Claude Fable 5                                                                                       | `claude-fable-5`             |122| Claude Opus 5                                                                                        | `claude-opus-5`              |123| Claude Opus 4.8                                                                                      | `claude-opus-4-8`            |124| Claude Opus 4.7                                                                                      | `claude-opus-4-7`            |125| Claude Opus 4.6                                                                                      | `claude-opus-4-6`            |126| Claude Opus 4.5                                                                                      | `claude-opus-4-5@20251101`   |127| Claude Opus 4.1 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations))  | `claude-opus-4-1@20250805`   |128| Claude Opus 4 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations))    | `claude-opus-4@20250514`     |129| Claude Sonnet 5                                                                                      | `claude-sonnet-5`            |130| Claude Sonnet 4.6                                                                                    | `claude-sonnet-4-6`          |131| Claude Sonnet 4.5                                                                                    | `claude-sonnet-4-5@20250929` |132| Claude Sonnet 4 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations))  | `claude-sonnet-4@20250514`   |133| Claude Haiku 4.5                                                                                     | `claude-haiku-4-5@20251001`  |134| Claude Haiku 3.5 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations)) | `claude-3-5-haiku@20241022`  |135136<Tip>137  Upgrading to a newer Claude model? In Claude Code, run `/claude-api migrate` to apply model ID swaps and breaking parameter changes across your codebase. The skill detects which cloud platform your code targets and adjusts model ID formats and feature changes for that platform. See [Migrating to a newer Claude model](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/claude-api-skill#migrating-to-a-newer-claude-model).138</Tip>139140### Making requests141142Before running requests you might need to run `gcloud auth application-default login` to authenticate with Google Cloud.143144The following examples show how to generate text from Claude on Agent Platform:145146<CodeGroup>147  ```bash cURL148  MODEL_ID=claude-opus-5149  PROJECT_ID=MY_PROJECT_ID150151  curl https://aiplatform.googleapis.com/v1/projects/${PROJECT_ID}/locations/global/publishers/anthropic/models/${MODEL_ID}:rawPredict \152    -H "Authorization: Bearer $(gcloud auth print-access-token)" \153    -H "Content-Type: application/json" \154    -d '{155      "anthropic_version": "vertex-2023-10-16",156      "messages": [{"role": "user", "content": "Hey Claude!"}],157      "max_tokens": 100158    }'159  ```160161  ```bash CLI162  # The ant CLI does not support Agent Platform.163  ```164165  ```python Python166  from anthropic import AnthropicVertex167168  project_id = "MY_PROJECT_ID"169  region = "global"170171  client = AnthropicVertex(project_id=project_id, region=region)172173  message = client.messages.create(174      model="claude-opus-5",175      max_tokens=100,176      messages=[177          {178              "role": "user",179              "content": "Hey Claude!",180          }181      ],182  )183  print(message)184  ```185186  ```typescript TypeScript187  import { AnthropicVertex } from "@anthropic-ai/vertex-sdk";188189  const projectId = "MY_PROJECT_ID";190  const region = "global";191192  // Goes through the standard `google-auth-library` flow.193  const client = new AnthropicVertex({194    projectId,195    region196  });197198  const result = await client.messages.create({199    model: "claude-opus-5",200    max_tokens: 100,201    messages: [202      {203        role: "user",204        content: "Hey Claude!"205      }206    ]207  });208  console.log(JSON.stringify(result, null, 2));209  ```210211  ```csharp C#212  using Anthropic.Models.Messages;213  using Anthropic.Vertex;214215  var projectId = "MY_PROJECT_ID";216  var region = "global";217218  var client = new AnthropicVertexClient(new AnthropicVertexCredentials(region, projectId));219220  var parameters = new MessageCreateParams221  {222      Model = Model.ClaudeOpus5,223      MaxTokens = 100,224      Messages = [new() { Role = Role.User, Content = "Hey Claude!" }]225  };226227  var message = await client.Messages.Create(parameters);228  Console.WriteLine(message);229  ```230231  ```go Go232  import (233  	"context"234  	"fmt"235236  	"github.com/anthropics/anthropic-sdk-go"237  	"github.com/anthropics/anthropic-sdk-go/vertex"238  )239  // ...240  	// Uses default Google Cloud credentials241  	client := anthropic.NewClient(242  		vertex.WithGoogleAuth(context.Background(), "global", "MY_PROJECT_ID"),243  	)244245  	message, err := client.Messages.New(context.Background(), anthropic.MessageNewParams{246  		Model:     anthropic.ModelClaudeOpus5,247  		MaxTokens: 100,248  		Messages: []anthropic.MessageParam{249  			anthropic.NewUserMessage(anthropic.NewTextBlock("Hey Claude!")),250  		},251  	})252  	if err != nil {253  		panic(err)254  	}255  	fmt.Printf("%+v\n", message)256  ```257258  ```java Java259  import com.anthropic.client.AnthropicClient;260  import com.anthropic.client.okhttp.AnthropicOkHttpClient;261  import com.anthropic.models.messages.Message;262  import com.anthropic.models.messages.MessageCreateParams;263  import com.anthropic.models.messages.Model;264  import com.anthropic.vertex.backends.VertexBackend;265266  void main() {267      // Uses default Google Cloud credentials268      AnthropicClient client = AnthropicOkHttpClient.builder()269          .backend(VertexBackend.fromEnv())270          .build();271272      Message message = client273          .messages()274          .create(275              MessageCreateParams.builder()276                  .model(Model.CLAUDE_OPUS_5)277                  .maxTokens(100)278                  .addUserMessage("Hey Claude!")279                  .build()280          );281282      IO.println(message);283  }284  ```285286  ```php PHP287  <?php288289  use Anthropic\Vertex;290291  $client = Vertex\Client::fromEnvironment(292      location: 'global',293      projectId: 'MY_PROJECT_ID',294  );295296  $message = $client->messages->create(297      maxTokens: 100,298      messages: [299          ['role' => 'user', 'content' => 'Hey Claude!']300      ],301      model: 'claude-opus-5',302  );303  $textBlock = array_find($message->content, static fn ($block): bool => $block->type === 'text');304  echo $textBlock->text;305  ```306307  ```ruby Ruby308  require "anthropic"309310  client = Anthropic::VertexClient.new(311    region: "global",312    project_id: "MY_PROJECT_ID"313  )314315  message = client.messages.create(316    model: "claude-opus-5",317    max_tokens: 100,318    messages: [{role: "user", content: "Hey Claude!"}]319  )320321  puts message.content.find { it.type == :text }.text322  ```323</CodeGroup>324325See the [client SDKs](https://platform.claude.com/docs/en/cli-sdks-libraries/overview) and the official [Agent Platform docs](https://cloud.google.com/vertex-ai/docs) for more details.326327Claude is also available through [Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry).328329## Data retention330331Data handling for this offering is governed by Google Cloud. For details, see [Agent Platform and zero data retention](https://cloud.google.com/vertex-ai/generative-ai/docs/data-governance).332333## Activity logging334335Agent Platform provides a [request-response logging service](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/request-response-logging) that allows you to log the prompts and completions associated with your usage.336337Anthropic recommends that you log your activity on at least a 30-day rolling basis to understand your activity and investigate any potential misuse.338339<Note>340  Turning on this service does not give Google or Anthropic any access to your content.341</Note>342343## Feature support344345For the full feature list with Google Cloud availability, see [Features overview](https://platform.claude.com/docs/en/build-with-claude/overview).346347### Supported feature highlights348349* [Messages API](https://platform.claude.com/docs/en/api/messages/create)350* [Prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching)351* [Thinking](https://platform.claude.com/docs/en/build-with-claude/thinking)352* [Tool use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview), including the [Bash tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool), [Browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool), [Computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), [Memory tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool), and [Text editor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool)353* [Web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)354* [Citations](https://platform.claude.com/docs/en/build-with-claude/citations)355* [Structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)356357### Features not supported358359* Input sources (URL sources for images and documents, Files API)360* Server-side tools (code execution, web fetch, advisor)361* Agent infrastructure (Agent Skills, MCP connector, programmatic tool calling)362* API endpoints (Message Batches, Models, Admin, Compliance, Usage and Cost)363* Claude Managed Agents364* Server-side fallback (the [`fallbacks` parameter](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#server-side-fallback); use the [client-side fallback pattern](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#client-side-fallback) instead)365366### Context window367368Claude Fable 5.1, Claude Fable 5, Claude Opus 5, Claude Opus 4.8, Claude Opus 4.7, Claude Opus 4.6, Claude Sonnet 5, and Claude Sonnet 4.6 have a [1M-token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) on Agent Platform. Other Claude models, including Sonnet 4.5 and Sonnet 4 (deprecated), have a 200k-token context window.369370Agent Platform limits request payloads to 30 MB. When sending large documents or many images, you might reach this limit before the token limit.371372## Global, multi-region, and regional endpoints373374Agent Platform offers three endpoint types:375376* **Global endpoints:** Dynamic routing for maximum availability377* **Multi-region endpoints:** Dynamic routing within a geographic area (for example, the United States or the European Union) for data residency with high availability378* **Regional endpoints:** Guaranteed data routing through specific geographic regions379380Regional and multi-region endpoints include a 10% pricing premium over global endpoints.381382<Note>383  This applies to Claude Sonnet 4.5 and future models only. Older models (Claude Sonnet 4 (deprecated), Opus 4 (deprecated), and earlier) maintain their existing pricing structures.384</Note>385386### When to use each option387388**Global endpoints (recommended):**389390* Provide maximum availability and uptime391* Dynamically route requests to regions with available capacity392* No pricing premium393* Best for applications where data residency is flexible394* Only supports pay-as-you-go traffic (provisioned throughput requires regional endpoints)395396**Multi-region endpoints:**397398* Dynamically route requests across regions within a geographic area (currently `us` and `eu`)399* Useful when you need data residency within a broad geography but want higher availability than a single region400* 10% pricing premium over global endpoints401* Only supports pay-as-you-go traffic (provisioned throughput requires regional endpoints)402403**Regional endpoints:**404405* Route traffic through specific geographic regions406* Required for single-region data residency, strict compliance mandates, or provisioned throughput407* Support both pay-as-you-go and provisioned throughput408* 10% pricing premium reflects infrastructure costs for dedicated regional capacity409410### Implementation411412**Using global endpoints (recommended):**413414Set the `region` parameter to `"global"` when initializing the client:415416<CodeGroup>417  ```bash cURL418  MODEL_ID=claude-opus-5419  PROJECT_ID=MY_PROJECT_ID420421  curl https://aiplatform.googleapis.com/v1/projects/${PROJECT_ID}/locations/global/publishers/anthropic/models/${MODEL_ID}:rawPredict \422    -H "Authorization: Bearer $(gcloud auth print-access-token)" \423    -H "Content-Type: application/json" \424    -d '{425      "anthropic_version": "vertex-2023-10-16",426      "messages": [{"role": "user", "content": "Hey Claude!"}],427      "max_tokens": 100428    }'429  ```430431  ```bash CLI432  # The ant CLI does not support Agent Platform.433  ```434435  ```python Python436  from anthropic import AnthropicVertex437438  project_id = "MY_PROJECT_ID"439  region = "global"440441  client = AnthropicVertex(project_id=project_id, region=region)442443  message = client.messages.create(444      model="claude-opus-5",445      max_tokens=100,446      messages=[447          {448              "role": "user",449              "content": "Hey Claude!",450          }451      ],452  )453  print(message)454  ```455456  ```typescript TypeScript457  import { AnthropicVertex } from "@anthropic-ai/vertex-sdk";458459  const projectId = "MY_PROJECT_ID";460  const region = "global";461462  const client = new AnthropicVertex({463    projectId,464    region465  });466467  const result = await client.messages.create({468    model: "claude-opus-5",469    max_tokens: 100,470    messages: [471      {472        role: "user",473        content: "Hey Claude!"474      }475    ]476  });477  console.log(JSON.stringify(result, null, 2));478  ```479480  ```csharp C#481  using Anthropic.Models.Messages;482  using Anthropic.Vertex;483484  var projectId = "MY_PROJECT_ID";485  var region = "global";486487  var client = new AnthropicVertexClient(new AnthropicVertexCredentials(region, projectId));488489  var parameters = new MessageCreateParams490  {491      Model = Model.ClaudeOpus5,492      MaxTokens = 100,493      Messages = [new() { Role = Role.User, Content = "Hey Claude!" }]494  };495496  var message = await client.Messages.Create(parameters);497  Console.WriteLine(message);498  ```499500  ```go Go501  import (502  	"context"503  	"fmt"504505  	"github.com/anthropics/anthropic-sdk-go"506  	"github.com/anthropics/anthropic-sdk-go/vertex"507  )508  // ...509  	// Uses default Google Cloud credentials510  	client := anthropic.NewClient(511  		vertex.WithGoogleAuth(context.Background(), "global", "MY_PROJECT_ID"),512  	)513514  	message, err := client.Messages.New(context.Background(), anthropic.MessageNewParams{515  		Model:     anthropic.ModelClaudeOpus5,516  		MaxTokens: 100,517  		Messages: []anthropic.MessageParam{518  			anthropic.NewUserMessage(anthropic.NewTextBlock("Hey Claude!")),519  		},520  	})521  	if err != nil {522  		panic(err)523  	}524  	fmt.Printf("%+v\n", message)525  ```526527  ```java Java528  import com.anthropic.client.AnthropicClient;529  import com.anthropic.client.okhttp.AnthropicOkHttpClient;530  import com.anthropic.models.messages.MessageCreateParams;531  import com.anthropic.models.messages.Model;532  import com.anthropic.vertex.backends.VertexBackend;533  import com.google.auth.oauth2.GoogleCredentials;534535  void main() throws Exception {536      // Uses default Google Cloud credentials537      AnthropicClient client = AnthropicOkHttpClient.builder()538          .backend(539              VertexBackend.builder()540                  .googleCredentials(GoogleCredentials.getApplicationDefault())541                  .region("global")542                  .project("MY_PROJECT_ID")543                  .build()544          )545          .build();546547      var message = client548          .messages()549          .create(550              MessageCreateParams.builder()551                  .model(Model.CLAUDE_OPUS_5)552                  .maxTokens(100)553                  .addUserMessage("Hey Claude!")554                  .build()555          );556557      IO.println(message);558  }559  ```560561  ```php PHP562  <?php563564  use Anthropic\Vertex;565566  $client = Vertex\Client::fromEnvironment(567      location: 'global',568      projectId: 'MY_PROJECT_ID',569  );570571  $message = $client->messages->create(572      maxTokens: 100,573      messages: [574          ['role' => 'user', 'content' => 'Hey Claude!']575      ],576      model: 'claude-opus-5',577  );578579  $textBlock = array_find($message->content, static fn ($block): bool => $block->type === 'text');580  echo $textBlock->text;581  ```582583  ```ruby Ruby584  require "anthropic"585586  client = Anthropic::VertexClient.new(587    region: "global",588    project_id: "MY_PROJECT_ID"589  )590591  message = client.messages.create(592    model: "claude-opus-5",593    max_tokens: 100,594    messages: [{role: "user", content: "Hey Claude!"}]595  )596597  puts message.content.find { it.type == :text }.text598  ```599</CodeGroup>600601**Using multi-region endpoints:**602603Set the `region` parameter to a multi-region identifier: `"us"` for the United States or `"eu"` for the European Union. The SDK routes requests to the corresponding multi-region endpoint (`https://aiplatform.us.rep.googleapis.com` or `https://aiplatform.eu.rep.googleapis.com`), which dynamically balances traffic across regions within that geography.604605<CodeGroup>606  ```bash cURL607  MODEL_ID=claude-opus-5608  LOCATION=us # Multi-region identifier: "us" or "eu"609  PROJECT_ID=MY_PROJECT_ID610611  curl https://aiplatform.${LOCATION}.rep.googleapis.com/v1/projects/${PROJECT_ID}/locations/${LOCATION}/publishers/anthropic/models/${MODEL_ID}:rawPredict \612    -H "Authorization: Bearer $(gcloud auth print-access-token)" \613    -H "Content-Type: application/json" \614    -d '{615      "anthropic_version": "vertex-2023-10-16",616      "messages": [{"role": "user", "content": "Hey Claude!"}],617      "max_tokens": 100618    }'619  ```620621  ```bash CLI622  # The ant CLI does not support Agent Platform.623  ```624625  ```python Python626  from anthropic import AnthropicVertex627628  project_id = "MY_PROJECT_ID"629  region = "us"  # Multi-region identifier: "us" or "eu"630631  client = AnthropicVertex(project_id=project_id, region=region)632633  message = client.messages.create(634      model="claude-opus-5",635      max_tokens=100,636      messages=[637          {638              "role": "user",639              "content": "Hey Claude!",640          }641      ],642  )643  print(message)644  ```645646  ```typescript TypeScript647  import { AnthropicVertex } from "@anthropic-ai/vertex-sdk";648649  const projectId = "MY_PROJECT_ID";650  const region = "us"; // Multi-region identifier: "us" or "eu"651652  const client = new AnthropicVertex({653    projectId,654    region655  });656657  const result = await client.messages.create({658    model: "claude-opus-5",659    max_tokens: 100,660    messages: [661      {662        role: "user",663        content: "Hey Claude!"664      }665    ]666  });667  console.log(JSON.stringify(result, null, 2));668  ```669670  ```csharp C#671  using Anthropic.Models.Messages;672  using Anthropic.Vertex;673674  var projectId = "MY_PROJECT_ID";675  var region = "us"; // Multi-region identifier: "us" or "eu"676677  var client = new AnthropicVertexClient(new AnthropicVertexCredentials(region, projectId));678679  var parameters = new MessageCreateParams680  {681      Model = Model.ClaudeOpus5,682      MaxTokens = 100,683      Messages = [new() { Role = Role.User, Content = "Hey Claude!" }]684  };685686  var message = await client.Messages.Create(parameters);687  Console.WriteLine(message);688  ```689690  ```go Go691  import (692  	"context"693  	"fmt"694695  	"github.com/anthropics/anthropic-sdk-go"696  	"github.com/anthropics/anthropic-sdk-go/vertex"697  )698  // ...699  	// Multi-region identifier: "us" or "eu"700  	client := anthropic.NewClient(701  		vertex.WithGoogleAuth(context.Background(), "us", "MY_PROJECT_ID"),702  	)703704  	message, err := client.Messages.New(context.Background(), anthropic.MessageNewParams{705  		Model:     anthropic.ModelClaudeOpus5,706  		MaxTokens: 100,707  		Messages: []anthropic.MessageParam{708  			anthropic.NewUserMessage(anthropic.NewTextBlock("Hey Claude!")),709  		},710  	})711  	if err != nil {712  		panic(err)713  	}714  	fmt.Printf("%+v\n", message)715  ```716717  ```java Java718  import com.anthropic.client.AnthropicClient;719  import com.anthropic.client.okhttp.AnthropicOkHttpClient;720  import com.anthropic.models.messages.MessageCreateParams;721  import com.anthropic.models.messages.Model;722  import com.anthropic.vertex.backends.VertexBackend;723  import com.google.auth.oauth2.GoogleCredentials;724725  void main() throws Exception {726      // Multi-region identifier: "us" or "eu"727      AnthropicClient client = AnthropicOkHttpClient.builder()728          .backend(729              VertexBackend.builder()730                  .googleCredentials(GoogleCredentials.getApplicationDefault())731                  .region("us")732                  .project("MY_PROJECT_ID")733                  .build()734          )735          .build();736737      var message = client738          .messages()739          .create(740              MessageCreateParams.builder()741                  .model(Model.CLAUDE_OPUS_5)742                  .maxTokens(100)743                  .addUserMessage("Hey Claude!")744                  .build()745          );746747      IO.println(message);748  }749  ```750751  ```php PHP752  <?php753754  use Anthropic\Vertex;755756  $client = Vertex\Client::fromEnvironment(757      location: 'us', // Multi-region identifier: "us" or "eu"758      projectId: 'MY_PROJECT_ID',759  );760761  $message = $client->messages->create(762      maxTokens: 100,763      messages: [764          ['role' => 'user', 'content' => 'Hey Claude!']765      ],766      model: 'claude-opus-5',767  );768  $textBlock = array_find($message->content, static fn ($block): bool => $block->type === 'text');769  echo $textBlock->text;770  ```771772  ```ruby Ruby773  require "anthropic"774775  client = Anthropic::VertexClient.new(776    region: "us", # Multi-region identifier: "us" or "eu"777    project_id: "MY_PROJECT_ID"778  )779780  message = client.messages.create(781    model: "claude-opus-5",782    max_tokens: 100,783    messages: [{role: "user", content: "Hey Claude!"}]784  )785786  puts message.content.find { it.type == :text }.text787  ```788</CodeGroup>789790**Using regional endpoints:**791792Specify a specific region such as `"us-east5"` or `"europe-west1"`:793794<CodeGroup>795  ```bash cURL796  # Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints797  MODEL_ID=claude-sonnet-4-6798  LOCATION=us-east5 # Specify a specific region799  PROJECT_ID=MY_PROJECT_ID800801  curl https://${LOCATION}-aiplatform.googleapis.com/v1/projects/${PROJECT_ID}/locations/${LOCATION}/publishers/anthropic/models/${MODEL_ID}:rawPredict \802    -H "Authorization: Bearer $(gcloud auth print-access-token)" \803    -H "Content-Type: application/json" \804    -d '{805      "anthropic_version": "vertex-2023-10-16",806      "messages": [{"role": "user", "content": "Hey Claude!"}],807      "max_tokens": 100808    }'809  ```810811  ```bash CLI812  # The ant CLI does not support Agent Platform.813  ```814815  ```python Python816  from anthropic import AnthropicVertex817818  project_id = "MY_PROJECT_ID"819  region = "us-east5"  # Specify a specific region820821  client = AnthropicVertex(project_id=project_id, region=region)822823  message = client.messages.create(824      # Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints825      model="claude-sonnet-4-6",826      max_tokens=100,827      messages=[828          {829              "role": "user",830              "content": "Hey Claude!",831          }832      ],833  )834  print(message)835  ```836837  ```typescript TypeScript838  import { AnthropicVertex } from "@anthropic-ai/vertex-sdk";839840  const projectId = "MY_PROJECT_ID";841  const region = "us-east5"; // Specify a specific region842843  const client = new AnthropicVertex({844    projectId,845    region846  });847848  const result = await client.messages.create({849    // Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints850    model: "claude-sonnet-4-6",851    max_tokens: 100,852    messages: [853      {854        role: "user",855        content: "Hey Claude!"856      }857    ]858  });859  console.log(JSON.stringify(result, null, 2));860  ```861862  ```csharp C#863  using Anthropic.Models.Messages;864  using Anthropic.Vertex;865866  var projectId = "MY_PROJECT_ID";867  var region = "us-east5"; // Specify a specific region868869  var client = new AnthropicVertexClient(new AnthropicVertexCredentials(region, projectId));870871  var parameters = new MessageCreateParams872  {873      // Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints874      Model = Model.ClaudeSonnet4_6,875      MaxTokens = 100,876      Messages = [new() { Role = Role.User, Content = "Hey Claude!" }]877  };878879  var message = await client.Messages.Create(parameters);880  Console.WriteLine(message);881  ```882883  ```go Go884  import (885  	"context"886  	"fmt"887888  	"github.com/anthropics/anthropic-sdk-go"889  	"github.com/anthropics/anthropic-sdk-go/vertex"890  )891  // ...892  	// Specify a specific region893  	client := anthropic.NewClient(894  		vertex.WithGoogleAuth(context.Background(), "us-east5", "MY_PROJECT_ID"),895  	)896897  	message, err := client.Messages.New(context.Background(), anthropic.MessageNewParams{898  		// Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints899  		Model:     anthropic.ModelClaudeSonnet4_6,900  		MaxTokens: 100,901  		Messages: []anthropic.MessageParam{902  			anthropic.NewUserMessage(anthropic.NewTextBlock("Hey Claude!")),903  		},904  	})905  	if err != nil {906  		panic(err)907  	}908  	fmt.Printf("%+v\n", message)909  ```910911  ```java Java912  import com.anthropic.client.AnthropicClient;913  import com.anthropic.client.okhttp.AnthropicOkHttpClient;914  import com.anthropic.models.messages.MessageCreateParams;915  import com.anthropic.models.messages.Model;916  import com.anthropic.vertex.backends.VertexBackend;917  import com.google.auth.oauth2.GoogleCredentials;918919  void main() throws Exception {920      // Uses default Google Cloud credentials with specific region921      AnthropicClient client = AnthropicOkHttpClient.builder()922          .backend(923              VertexBackend.builder()924                  .googleCredentials(GoogleCredentials.getApplicationDefault())925                  .region("us-east5") // Specify a specific region926                  .project("MY_PROJECT_ID")927                  .build()928          )929          .build();930931      var message = client932          .messages()933          .create(934              MessageCreateParams.builder()935                  // Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints936                  .model(Model.CLAUDE_SONNET_4_6)937                  .maxTokens(100)938                  .addUserMessage("Hey Claude!")939                  .build()940          );941942      IO.println(message);943  }944  ```945946  ```php PHP947  <?php948949  use Anthropic\Vertex;950951  $client = Vertex\Client::fromEnvironment(952      location: 'us-east5',953      projectId: 'MY_PROJECT_ID',954  );955956  $message = $client->messages->create(957      maxTokens: 100,958      messages: [959          ['role' => 'user', 'content' => 'Hey Claude!']960      ],961      // Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints962      model: 'claude-sonnet-4-6',963  );964  echo $message->content[0]->text;965  ```966967  ```ruby Ruby968  require "anthropic"969970  client = Anthropic::VertexClient.new(971    region: "us-east5", # Specify a specific region972    project_id: "MY_PROJECT_ID"973  )974975  message = client.messages.create(976    # Specific regional endpoints support Claude Sonnet 4.6 and earlier; newer models use the global or multi-region endpoints977    model: "claude-sonnet-4-6",978    max_tokens: 100,979    messages: [{role: "user", content: "Hey Claude!"}]980  )981982  puts message.content.first.text983  ```984</CodeGroup>985986<Note>987  Claude Mythos Preview is a research preview available to invited customers on Agent Platform. For more information, see [Project Glasswing](https://anthropic.com/glasswing).988</Note>989990## Additional resources991992* **Agent Platform pricing:** [Generative AI pricing on cloud.google.com](https://cloud.google.com/vertex-ai/generative-ai/pricing)993* **Claude models documentation:** [Claude on Agent Platform](https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/partner-models/claude)994* **Google blog post:** [Global endpoint for Claude models](https://cloud.google.com/blog/products/ai-machine-learning/global-endpoint-for-claude-models-generally-available-on-vertex-ai)995* **Anthropic pricing details:** [Cloud platform pricing](https://platform.claude.com/docs/en/about-claude/pricing#cloud-platform-pricing)996
Files main
Menu

Theme