@ai-sdk/anthropic 4.0.84 → 4.0.86

package/docs/05-anthropic.mdx

@@ -1,17 +1,61 @@
 ---
 title: Anthropic
-description: Learn how to use the Anthropic provider for the AI SDK.
+description: Learn how to use Anthropic with AI Gateway and the direct provider.
 ---
 
 # Anthropic Provider
 
 The [Anthropic](https://www.anthropic.com/) provider contains language model support for the [Anthropic Messages API](https://docs.anthropic.com/claude/reference/messages_post).
+You can use Anthropic models through [AI Gateway](/providers/ai-sdk-providers/ai-gateway) (recommended) or connect directly with `@ai-sdk/anthropic`.
 
-## Setup
+```ts provider="anthropic" model="anthropic/claude-sonnet-5.5"
+import { generateText } from 'ai';
+__PROVIDER_IMPORT__;
+
+const { text } = await generateText({
+  model: __MODEL__,
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+
+console.log(text);
+```
+
+## Using AI Gateway
+
+The AI SDK uses AI Gateway by default for model strings. Gateway provides access to models across providers through a single API key, with usage and cost tracking. Install `ai`:
+
+<InstallPackages packages="ai" />
+
+Set an [AI Gateway API key](https://vercel.com/docs/ai-gateway/getting-started) in your environment:
 
-The Anthropic provider is available in the `@ai-sdk/anthropic` module. You can install it with
+```bash
+export AI_GATEWAY_API_KEY=your_api_key_here
+```
+
+Vercel deployments can also use [OIDC authentication](/providers/ai-sdk-providers/ai-gateway#oidc-authentication-vercel-deployments).
+See the [AI Gateway provider documentation](/providers/ai-sdk-providers/ai-gateway) for configuration and the [model catalog](https://vercel.com/ai-gateway/models) for available models.
+
+Gateway feature and provider-option support depends on the model and the provider serving the request. See [Gateway provider options](https://vercel.com/docs/ai-gateway/models-and-providers/provider-options).
+
+## Using `@ai-sdk/anthropic`
+
+For direct access to Anthropic, install `ai` and `@ai-sdk/anthropic`:
+
+<InstallPackages packages="ai @ai-sdk/anthropic" />
 
-<InstallPackages packages="@ai-sdk/anthropic" />
+Set your Anthropic API credential in the `ANTHROPIC_API_KEY` environment variable:
+
+```bash
+export ANTHROPIC_API_KEY=your_api_key_here
+```
+
+AI Gateway does not expose every API in `@ai-sdk/anthropic`. Use the direct provider for provider-specific APIs or custom connection settings.
+
+<Note>
+  The following sections document the direct `@ai-sdk/anthropic` provider,
+  including its model factories and settings. Gateway model and feature
+  availability can differ.
+</Note>
 
 ## Provider Instance
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/anthropic",
-  "version": "4.0.84",
+  "version": "4.0.86",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -35,8 +35,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "4.0.31",
-    "@ai-sdk/provider-utils": "5.0.64"
+    "@ai-sdk/provider": "4.0.32",
+    "@ai-sdk/provider-utils": "5.0.66"
   },
   "devDependencies": {
     "@ai-sdk/test-server": "2.0.4",

package/src/anthropic-api.ts

@@ -77,14 +77,18 @@ export interface AnthropicAssistantMessage {
   >;
 }
 
-export const anthropicFallbackContentSchema = z.object({
-  type: z.literal('fallback'),
-  from: z.object({ model: z.string() }),
-  to: z.object({ model: z.string() }),
-});
+export const anthropicFallbackContentSchema = () =>
+  z.object({
+    type: z.literal('fallback'),
+    from: z.object({ model: z.string() }),
+    to: z.object({ model: z.string() }),
+  });
+export const anthropicFallbackContentSchemaValidator = lazySchema(() =>
+  zodSchema(anthropicFallbackContentSchema()),
+);
 
 export type AnthropicFallbackContent = InferSchema<
-  typeof anthropicFallbackContentSchema
+  ReturnType<typeof anthropicFallbackContentSchema>
 > & {
   cache_control?: never;
 };
@@ -689,117 +693,125 @@ export type AnthropicResponseContextManagement = {
   applied_edits: AnthropicResponseContextManagementEdit[];
 };
 
-const anthropicStopDetailsSchema = z.object({
-  type: z.string(),
-  category: z.string().nullish(),
-  explanation: z.string().nullish(),
-  recommended_model: z.string().nullish(),
-});
+const anthropicStopDetailsSchema = () =>
+  z.object({
+    type: z.string(),
+    category: z.string().nullish(),
+    explanation: z.string().nullish(),
+    recommended_model: z.string().nullish(),
+  });
 
-export type AnthropicStopDetails = z.infer<typeof anthropicStopDetailsSchema>;
+export type AnthropicStopDetails = z.infer<
+  ReturnType<typeof anthropicStopDetailsSchema>
+>;
 
-const anthropicSafeguardResultSchema = z.object({
-  type: z.string(),
-  status: z.object({
+const anthropicSafeguardResultSchema = () =>
+  z.object({
     type: z.string(),
-    tool_uses: z
-      .record(
-        z.string(),
-        z.object({
-          type: z.string(),
-          outcome: z.string().nullish(),
-          explanation: z.string().nullish(),
-        }),
-      )
-      .nullish(),
-  }),
-});
+    status: z.object({
+      type: z.string(),
+      tool_uses: z
+        .record(
+          z.string(),
+          z.object({
+            type: z.string(),
+            outcome: z.string().nullish(),
+            explanation: z.string().nullish(),
+          }),
+        )
+        .nullish(),
+    }),
+  });
 
 export type AnthropicSafeguardResult = z.infer<
-  typeof anthropicSafeguardResultSchema
+  ReturnType<typeof anthropicSafeguardResultSchema>
 >;
 
-const anthropicToolCallCallerSchema = z.union([
-  z.object({
-    type: z.literal('code_execution_20250825'),
-    tool_id: z.string(),
-  }),
-  z.object({
-    type: z.literal('code_execution_20260120'),
-    tool_id: z.string(),
-  }),
-  z.object({
-    type: z.literal('direct'),
-  }),
-]);
+const anthropicToolCallCallerSchema = () =>
+  z.union([
+    z.object({
+      type: z.literal('code_execution_20250825'),
+      tool_id: z.string(),
+    }),
+    z.object({
+      type: z.literal('code_execution_20260120'),
+      tool_id: z.string(),
+    }),
+    z.object({
+      type: z.literal('direct'),
+    }),
+  ]);
 
-const anthropicCitationSchema = z.discriminatedUnion('type', [
-  z.object({
-    type: z.literal('web_search_result_location'),
-    cited_text: z.string(),
-    url: z.string(),
-    title: z.string().nullable(),
-    encrypted_index: z.string(),
-  }),
-  z.object({
-    type: z.literal('page_location'),
-    cited_text: z.string(),
-    document_index: z.number(),
-    document_title: z.string().nullable(),
-    start_page_number: z.number(),
-    end_page_number: z.number(),
-    file_id: z.string().nullish(),
-  }),
-  z.object({
-    type: z.literal('char_location'),
-    cited_text: z.string(),
-    document_index: z.number(),
-    document_title: z.string().nullable(),
-    start_char_index: z.number(),
-    end_char_index: z.number(),
-    file_id: z.string().nullish(),
-  }),
-  z.object({
-    type: z.literal('content_block_location'),
-    cited_text: z.string(),
-    document_index: z.number(),
-    document_title: z.string().nullable(),
-    start_block_index: z.number(),
-    end_block_index: z.number(),
-    file_id: z.string().nullable(),
-  }),
-  z.object({
-    type: z.literal('search_result_location'),
-    cited_text: z.string(),
-    search_result_index: z.number(),
-    source: z.string(),
-    title: z.string().nullable(),
-    start_block_index: z.number(),
-    end_block_index: z.number(),
-  }),
-]);
-
-const anthropicMcpToolResultContentSchema = z.union([
-  z.string(),
-  z.array(
-    z.union([
-      z.string(),
-      z.object({
-        type: z.literal('text'),
-        text: z.string(),
-        // MCP tool-result citations are opaque third-party pass-through data.
-        // Keep them permissive so new shapes do not reject whole responses.
-        citations: z.array(z.json()).nullable().optional(),
-      }),
-    ]),
-  ),
-]);
+const anthropicCitationSchema = () =>
+  z.discriminatedUnion('type', [
+    z.object({
+      type: z.literal('web_search_result_location'),
+      cited_text: z.string(),
+      url: z.string(),
+      title: z.string().nullable(),
+      encrypted_index: z.string(),
+    }),
+    z.object({
+      type: z.literal('page_location'),
+      cited_text: z.string(),
+      document_index: z.number(),
+      document_title: z.string().nullable(),
+      start_page_number: z.number(),
+      end_page_number: z.number(),
+      file_id: z.string().nullish(),
+    }),
+    z.object({
+      type: z.literal('char_location'),
+      cited_text: z.string(),
+      document_index: z.number(),
+      document_title: z.string().nullable(),
+      start_char_index: z.number(),
+      end_char_index: z.number(),
+      file_id: z.string().nullish(),
+    }),
+    z.object({
+      type: z.literal('content_block_location'),
+      cited_text: z.string(),
+      document_index: z.number(),
+      document_title: z.string().nullable(),
+      start_block_index: z.number(),
+      end_block_index: z.number(),
+      file_id: z.string().nullable(),
+    }),
+    z.object({
+      type: z.literal('search_result_location'),
+      cited_text: z.string(),
+      search_result_index: z.number(),
+      source: z.string(),
+      title: z.string().nullable(),
+      start_block_index: z.number(),
+      end_block_index: z.number(),
+    }),
+  ]);
+
+const anthropicMcpToolResultContentSchema = () =>
+  z.union([
+    z.string(),
+    z.array(
+      z.union([
+        z.string(),
+        z.object({
+          type: z.literal('text'),
+          text: z.string(),
+          // MCP tool-result citations are opaque third-party pass-through data.
+          // Keep them permissive so new shapes do not reject whole responses.
+          citations: z.array(z.json()).nullable().optional(),
+        }),
+      ]),
+    ),
+  ]);
 
-const anthropicInputTransformationSchema = z.object({
-  type: z.string(),
-  path: z.string(),
-  reason: z.string(),
-});
+const anthropicInputTransformationSchema = () =>
+  z.object({
+    type: z.string(),
+    path: z.string(),
+    reason: z.string(),
+  });
 
 // limited version of the schema, focussed on what is needed for the implementation
 // this approach limits breakages when the API changes and increases efficiency
@@ -814,7 +826,7 @@ export const anthropicResponseSchema = lazySchema(() =>
           z.object({
             type: z.literal('text'),
             text: z.string(),
-            citations: z.array(anthropicCitationSchema).nullable().optional(),
+            citations: z.array(anthropicCitationSchema()).nullable().optional(),
           }),
           z.object({
             type: z.literal('thinking'),
@@ -836,7 +848,7 @@ export const anthropicResponseSchema = lazySchema(() =>
             name: z.string(),
             input: z.unknown(),
             // Programmatic tool calling: caller info when triggered from code execution
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
             // Toolsets (e.g. computer toolset): name of the toolset this member call belongs to
             toolset_name: z.string().nullish(),
           }),
@@ -845,7 +857,7 @@ export const anthropicResponseSchema = lazySchema(() =>
             id: z.string(),
             name: z.string(),
             input: z.record(z.string(), z.unknown()).nullish(),
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
           }),
           z.object({
             type: z.literal('mcp_tool_use'),
@@ -858,12 +870,12 @@ export const anthropicResponseSchema = lazySchema(() =>
             type: z.literal('mcp_tool_result'),
             tool_use_id: z.string(),
             is_error: z.boolean(),
-            content: anthropicMcpToolResultContentSchema,
+            content: anthropicMcpToolResultContentSchema(),
           }),
           z.object({
             type: z.literal('web_fetch_tool_result'),
             tool_use_id: z.string(),
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
             content: z.union([
               z.object({
                 type: z.literal('web_fetch_result'),
@@ -896,7 +908,7 @@ export const anthropicResponseSchema = lazySchema(() =>
           z.object({
             type: z.literal('web_search_tool_result'),
             tool_use_id: z.string(),
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
             content: z.union([
               z.array(
                 z.object({
@@ -1055,16 +1067,16 @@ export const anthropicResponseSchema = lazySchema(() =>
               }),
             ]),
           }),
-          anthropicFallbackContentSchema,
+          anthropicFallbackContentSchema(),
         ]),
       ),
       stop_reason: z.string().nullish(),
       stop_sequence: z.string().nullish(),
-      stop_details: anthropicStopDetailsSchema.nullish(),
+      stop_details: anthropicStopDetailsSchema().nullish(),
       input_transformations: z
-        .array(anthropicInputTransformationSchema)
+        .array(anthropicInputTransformationSchema())
         .nullish(),
-      safeguard_results: z.array(anthropicSafeguardResultSchema).nullish(),
+      safeguard_results: z.array(anthropicSafeguardResultSchema()).nullish(),
       usage: z.looseObject({
         input_tokens: z.number(),
         output_tokens: z.number(),
@@ -1158,7 +1170,7 @@ export const anthropicChunkSchema = lazySchema(() =>
                   id: z.string(),
                   name: z.string(),
                   input: z.unknown(),
-                  caller: anthropicToolCallCallerSchema.optional(),
+                  caller: anthropicToolCallCallerSchema().optional(),
                   toolset_name: z.string().nullish(),
                 }),
               ]),
@@ -1166,7 +1178,7 @@ export const anthropicChunkSchema = lazySchema(() =>
             .nullish(),
           stop_reason: z.string().nullish(),
           input_transformations: z
-            .array(anthropicInputTransformationSchema)
+            .array(anthropicInputTransformationSchema())
             .nullish(),
           container: z
             .object({
@@ -1195,7 +1207,7 @@ export const anthropicChunkSchema = lazySchema(() =>
             // Programmatic tool calling: input may be present directly for deferred tool calls
             input: z.record(z.string(), z.unknown()).optional(),
             // Programmatic tool calling: caller info when triggered from code execution
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
             // Toolsets (e.g. computer toolset): name of the toolset this member call belongs to
             toolset_name: z.string().nullish(),
           }),
@@ -1213,7 +1225,7 @@ export const anthropicChunkSchema = lazySchema(() =>
             id: z.string(),
             name: z.string(),
             input: z.record(z.string(), z.unknown()).nullish(),
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
           }),
           z.object({
             type: z.literal('mcp_tool_use'),
@@ -1226,12 +1238,12 @@ export const anthropicChunkSchema = lazySchema(() =>
             type: z.literal('mcp_tool_result'),
             tool_use_id: z.string(),
             is_error: z.boolean(),
-            content: anthropicMcpToolResultContentSchema,
+            content: anthropicMcpToolResultContentSchema(),
           }),
           z.object({
             type: z.literal('web_fetch_tool_result'),
             tool_use_id: z.string(),
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
             content: z.union([
               z.object({
                 type: z.literal('web_fetch_result'),
@@ -1264,7 +1276,7 @@ export const anthropicChunkSchema = lazySchema(() =>
           z.object({
             type: z.literal('web_search_tool_result'),
             tool_use_id: z.string(),
-            caller: anthropicToolCallCallerSchema.optional(),
+            caller: anthropicToolCallCallerSchema().optional(),
             content: z.union([
               z.array(
                 z.object({
@@ -1419,7 +1431,7 @@ export const anthropicChunkSchema = lazySchema(() =>
               }),
             ]),
           }),
-          anthropicFallbackContentSchema,
+          anthropicFallbackContentSchema(),
         ]),
       }),
       z.object({
@@ -1448,7 +1460,7 @@ export const anthropicChunkSchema = lazySchema(() =>
           }),
           z.object({
             type: z.literal('citations_delta'),
-            citation: anthropicCitationSchema,
+            citation: anthropicCitationSchema(),
           }),
         ]),
       }),
@@ -1472,8 +1484,10 @@ export const anthropicChunkSchema = lazySchema(() =>
         delta: z.object({
           stop_reason: z.string().nullish(),
           stop_sequence: z.string().nullish(),
-          stop_details: anthropicStopDetailsSchema.nullish(),
-          safeguard_results: z.array(anthropicSafeguardResultSchema).nullish(),
+          stop_details: anthropicStopDetailsSchema().nullish(),
+          safeguard_results: z
+            .array(anthropicSafeguardResultSchema())
+            .nullish(),
           container: z
             .object({
               expires_at: z.string(),
@@ -1522,7 +1536,7 @@ export const anthropicChunkSchema = lazySchema(() =>
             .nullish(),
         }),
         input_transformations: z
-          .array(anthropicInputTransformationSchema)
+          .array(anthropicInputTransformationSchema())
           .nullish(),
         context_management: z
           .object({

package/src/anthropic-batch.ts

@@ -49,10 +49,7 @@ import {
   AnthropicLanguageModel,
   type AnthropicLanguageModelConfig,
 } from './anthropic-language-model';
-import {
-  anthropicLanguageModelOptions,
-  type AnthropicModelId,
-} from './anthropic-language-model-options';
+import type { AnthropicModelId } from './anthropic-language-model-options';
 import type {
   AnthropicMessageMetadata,
   AnthropicUsageIteration,
@@ -62,9 +59,13 @@ import { mapAnthropicStopReason } from './map-anthropic-stop-reason';
 
 const anthropicBatchRequestIdPattern = /^[A-Za-z0-9_-]{1,64}$/;
 
-const anthropicBatchProviderOptionsSchema = anthropicLanguageModelOptions.pick({
-  anthropicBeta: true,
-});
+const anthropicBatchProviderOptionsSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      anthropicBeta: z.array(z.string()).optional(),
+    }),
+  ),
+);
 
 type AnthropicBatchRequest = TextBatchV4Request<AnthropicModelId>;