---
title: AI Gateway
description: Learn how to use the AI Gateway provider with the AI SDK.
url: "https://ai-sdk.dev/v5/providers/ai-sdk-providers/ai-gateway"
docs_index: /llms.txt
---

> For an index of all documentation, see [/llms.txt](/llms.txt).

The [AI Gateway](https://vercel.com/docs/ai-gateway) provider connects you to models from multiple AI providers through a single interface. Instead of integrating with each provider separately, you can access OpenAI, Anthropic, Google, Meta, xAI, and other providers and their models.

## Features

- Access models from multiple providers without having to install additional provider modules/dependencies
- Use the same code structure across different AI providers
- Switch between models and providers easily
- Automatic authentication when deployed on Vercel
- View pricing information across providers
- Observability for AI model usage through the Vercel dashboard

## Setup

The Vercel AI Gateway provider is part of the AI SDK.

## Basic Usage

For most use cases, you can use the AI Gateway directly with a model string:

```ts
// use plain model string with global provider
import { generateText } from "ai";

const { text } = await generateText({
  model: "openai/gpt-5.4",
  prompt: "Hello world",
});
```

```ts
// use provider instance (requires version 5.0.36 or later)
import { generateText, gateway } from "ai";

const { text } = await generateText({
  model: gateway("openai/gpt-5.4"),
  prompt: "Hello world",
});
```

The AI SDK automatically uses the AI Gateway when you pass a model string in the `creator/model-name` format.

## Provider Instance

The `gateway` provider instance is available from the `ai` package in version
5.0.36 and later.

You can also import the default provider instance `gateway` from `ai`:

```ts
import { gateway } from "ai";
```

You may want to create a custom provider instance when you need to:

- Set custom configuration options (API key, base URL, headers)
- Use the provider in a [provider registry](/v5/docs/ai-sdk-core/provider-management)
- Wrap the provider with [middleware](/v5/docs/ai-sdk-core/middleware)
- Use different settings for different parts of your application

To create a custom provider instance, import `createGateway` from `ai`:

```ts
import { createGateway } from "ai";

const gateway = createGateway({
  apiKey: process.env.AI_GATEWAY_API_KEY ?? "",
});
```

You can use the following optional settings to customize the AI Gateway provider instance:

- **baseURL** *string*

  Use a different URL prefix for API calls. The default prefix is `https://ai-gateway.vercel.sh/v1/ai`.

- **apiKey** *string*

  API key that is being sent using the `Authorization` header. It defaults to
  the `AI_GATEWAY_API_KEY` environment variable.

- **headers** *Record\<string,string>*

  Custom headers to include in the requests.

- **fetch** *(input: RequestInfo, init?: RequestInit) => Promise\<Response>*

  Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation.
  Defaults to the global `fetch` function.
  You can use it as a middleware to intercept requests,
  or to provide a custom fetch implementation for e.g. testing.

- **metadataCacheRefreshMillis** *number*

  How frequently to refresh the metadata cache in milliseconds. Defaults to 5 minutes (300,000ms).

## Authentication

The Gateway provider supports two authentication methods:

### API Key Authentication

Set your API key via environment variable:

```bash
AI_GATEWAY_API_KEY=your_api_key_here
```

Or pass it directly to the provider:

```ts
import { createGateway } from "ai";

const gateway = createGateway({
  apiKey: "your_api_key_here",
});
```

### OIDC Authentication (Vercel Deployments)

When deployed to Vercel, the AI Gateway provider supports authenticating using [OIDC (OpenID Connect)
tokens](https://vercel.com/docs/oidc) without API Keys.

#### How OIDC Authentication Works

1. **In Production/Preview Deployments**:

   - OIDC authentication is automatically handled
   - No manual configuration needed
   - Tokens are automatically obtained and refreshed

2. **In Local Development**:
   - First, install and authenticate with the [Vercel CLI](https://vercel.com/docs/cli)
   - Run `vercel env pull` to download your project's OIDC token locally
   - For automatic token management:
     - Use `vercel dev` to start your development server - this will handle token refreshing automatically
   - For manual token management:
     - If not using `vercel dev`, note that OIDC tokens expire after 12 hours
     - You'll need to run `vercel env pull` again to refresh the token before it expires

If an API Key is present (either passed directly or via environment), it will
always be used, even if invalid.

Read more about using OIDC tokens in the [Vercel AI Gateway docs](https://vercel.com/docs/ai-gateway#using-the-ai-gateway-with-a-vercel-oidc-token).

## Bring Your Own Key (BYOK)

You can connect your own provider credentials to use with Vercel AI Gateway. This lets you use your existing provider accounts and access private resources.

To set up BYOK, add your provider credentials in your Vercel team's AI Gateway settings. Once configured, AI Gateway automatically uses your credentials. No code changes are needed.

For providers like Azure where you can use custom deployment names, you can configure model mappings to map gateway model slugs to your deployment names. See [model mappings](https://vercel.com/docs/ai-gateway/byok#model-mappings) for details.

Learn more in the [BYOK documentation](https://vercel.com/docs/ai-gateway/byok).

## Language Models

You can create language models using a provider instance. The first argument is the model ID in the format `creator/model-name`:

```ts
import { generateText } from "ai";

const { text } = await generateText({
  model: "openai/gpt-5.4",
  prompt: "Explain quantum computing in simple terms",
});
```

AI Gateway language models can also be used in the `streamText`, `generateObject`, and `streamObject` functions (see [AI SDK Core](/v5/docs/ai-sdk-core)).

## Available Models

The AI Gateway supports models from OpenAI, Anthropic, Google, Meta, xAI, Mistral, DeepSeek, Amazon Bedrock, Cohere, Perplexity, Alibaba, and other providers.

For the complete list of available models, see the [AI Gateway documentation](https://vercel.com/docs/ai-gateway).

## Dynamic Model Discovery

You can discover available models programmatically:

```ts
import { gateway, generateText } from "ai";

const availableModels = await gateway.getAvailableModels();

// List all available models
availableModels.models.forEach((model) => {
  console.log(`${model.id}: ${model.name}`);
  if (model.description) {
    console.log(`  Description: ${model.description}`);
  }
  if (model.pricing) {
    console.log(`  Input: $${model.pricing.input}/token`);
    console.log(`  Output: $${model.pricing.output}/token`);
    if (model.pricing.cachedInputTokens) {
      console.log(
        `  Cached input (read): $${model.pricing.cachedInputTokens}/token`,
      );
    }
    if (model.pricing.cacheCreationInputTokens) {
      console.log(
        `  Cache creation (write): $${model.pricing.cacheCreationInputTokens}/token`,
      );
    }
  }
});

// Use any discovered model with plain string
const { text } = await generateText({
  model: availableModels.models[0].id, // e.g., 'openai/gpt-5.4'
  prompt: "Hello world",
});
```

## Credit Usage

You can check your team's current credit balance and usage:

```ts
import { gateway } from "ai";

const credits = await gateway.getCredits();

console.log(`Team balance: ${credits.balance} credits`);
console.log(`Team total used: ${credits.total_used} credits`);
```

The `getCredits()` method returns your team's credit information based on the authenticated API key or OIDC token:

- **balance** *number* - Your team's current available credit balance
- **total\_used** *number* - Total credits consumed by your team

## Generation Lookup

Look up detailed information about a specific generation by its ID, including cost, token usage, latency, and provider details. Generation IDs are available in `providerMetadata.gateway.generationId` on both `generateText` and `streamText` responses.

When streaming, the generation ID is injected on the first content chunk, so you can capture it early in the stream without waiting for completion. This is especially useful in cases where a network interruption or mid-stream error could prevent you from receiving the final response — since the gateway records the final status server-side, you can use the generation ID to look up the results (including cost, token usage, and finish reason) later via `getGenerationInfo()`.

```ts
import { gateway, generateText } from 'ai';

// Make a request
const result = await generateText({
  model: gateway('anthropic/claude-sonnet-4'),
  prompt: 'Explain quantum entanglement briefly',
});

// Get the generation ID from provider metadata
const generationId = result.providerMetadata?.gateway?.generationId;

// Look up detailed generation info
const generation = await gateway.getGenerationInfo({ id: generationId });

console.log(`Model: ${generation.model}`);
console.log(`Cost: $${generation.totalCost.toFixed(6)}`);
console.log(`Latency: ${generation.latency}ms`);
console.log(`Prompt tokens: ${generation.promptTokens}`);
console.log(`Completion tokens: ${generation.completionTokens}`);
```

With `streamText`, you can capture the generation ID from the first chunk via `fullStream`:

```ts
import { gateway, streamText } from 'ai';

const result = streamText({
  model: gateway('anthropic/claude-sonnet-4'),
  prompt: 'Explain quantum entanglement briefly',
});

let generationId: string | undefined;

for await (const part of result.fullStream) {
  if (!generationId && part.providerMetadata?.gateway?.generationId) {
    generationId = part.providerMetadata.gateway.generationId as string;
    console.log(`Generation ID (early): ${generationId}`);
  }
}

// Look up cost and usage after the stream completes
if (generationId) {
  const generation = await gateway.getGenerationInfo({ id: generationId });
  console.log(`Cost: $${generation.totalCost.toFixed(6)}`);
  console.log(`Finish reason: ${generation.finishReason}`);
}
```

The `getGenerationInfo()` method accepts:

- **id** *string* - The generation ID to look up (format: `gen_<ulid>`, required)

It returns a `GatewayGenerationInfo` object with the following fields:

- **id** *string* - The generation ID
- **totalCost** *number* - Total cost in USD
- **upstreamInferenceCost** *number* - Upstream inference cost in USD (relevant for BYOK)
- **usage** *number* - Usage cost in USD (same as totalCost)
- **createdAt** *string* - ISO 8601 timestamp when the generation was created
- **model** *string* - Model identifier used
- **isByok** *boolean* - Whether Bring Your Own Key credentials were used
- **providerName** *string* - The provider that served this generation
- **streamed** *boolean* - Whether streaming was used
- **finishReason** *string* - Finish reason (e.g. `'stop'`)
- **latency** *number* - Time to first token in milliseconds
- **generationTime** *number* - Total generation time in milliseconds
- **promptTokens** *number* - Number of prompt tokens
- **completionTokens** *number* - Number of completion tokens
- **reasoningTokens** *number* - Reasoning tokens used (if applicable)
- **cachedTokens** *number* - Cached tokens used (if applicable)
- **cacheCreationTokens** *number* - Cache creation input tokens
- **billableWebSearchCalls** *number* - Number of billable web search calls

## Examples

### Basic Text Generation

```ts
import { generateText } from "ai";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  prompt: "Write a haiku about programming",
});

console.log(text);
```

### Streaming

```ts
import { streamText } from "ai";

const { textStream } = await streamText({
  model: "openai/gpt-5.4",
  prompt: "Explain the benefits of serverless architecture",
});

for await (const textPart of textStream) {
  process.stdout.write(textPart);
}
```

### Tool Usage

```ts
import { generateText, tool } from "ai";
import { z } from "zod";

const { text } = await generateText({
  model: "xai/grok-4.5",
  prompt: "What is the weather like in San Francisco?",
  tools: {
    getWeather: tool({
      description: "Get the current weather for a location",
      parameters: z.object({
        location: z.string().describe("The location to get weather for"),
      }),
      execute: async ({ location }) => {
        // Your weather API call here
        return `It's sunny in ${location}`;
      },
    }),
  },
});
```

### Provider-Executed Tools

Some providers offer tools that are executed by the provider itself, such as [OpenAI's web search tool](/v5/providers/ai-sdk-providers/openai#web-search-tool). To use these tools through AI Gateway, import the provider to access the tool definitions:

```ts
import { generateText, stepCountIs } from "ai";
import { openai } from "@ai-sdk/openai";

const result = await generateText({
  model: "openai/gpt-5.4-mini",
  prompt: "What is the Vercel AI Gateway?",
  stopWhen: stepCountIs(10),
  tools: {
    web_search: openai.tools.webSearch({}),
  },
});

console.dir(result.text);
```

Some provider-executed tools require account-specific configuration (such as
Claude Agent Skills) and may not work through AI Gateway. To use these tools,
you must bring your own key (BYOK) directly to the provider.

### Gateway Tools

The AI Gateway provider includes built-in tools that are executed by the gateway itself. These tools can be used with any model through the gateway.

#### Perplexity Search

The Perplexity Search tool enables models to search the web using [Perplexity's search API](https://docs.perplexity.ai/guides/search-quickstart). This tool is executed by the AI Gateway and returns web search results that the model can use to provide up-to-date information.

```ts
import { gateway, generateText } from "ai";

const result = await generateText({
  model: "openai/gpt-5.4-nano",
  prompt: "Search for news about AI regulations in January 2025.",
  tools: {
    perplexity_search: gateway.tools.perplexitySearch(),
  },
});

console.log(result.text);
console.log("Tool calls:", JSON.stringify(result.toolCalls, null, 2));
console.log("Tool results:", JSON.stringify(result.toolResults, null, 2));
```

You can also configure the search with optional parameters:

```ts
import { gateway, generateText } from "ai";

const result = await generateText({
  model: "openai/gpt-5.4-nano",
  prompt:
    "Search for news about AI regulations from the first week of January 2025.",
  tools: {
    perplexity_search: gateway.tools.perplexitySearch({
      maxResults: 5,
      searchLanguageFilter: ["en"],
      country: "US",
      searchDomainFilter: ["reuters.com", "bbc.com", "nytimes.com"],
    }),
  },
});

console.log(result.text);
console.log("Tool calls:", JSON.stringify(result.toolCalls, null, 2));
console.log("Tool results:", JSON.stringify(result.toolResults, null, 2));
```

The Perplexity Search tool supports the following optional configuration options:

- **maxResults** *number*

  The maximum number of search results to return (1-20, default: 10).

- **maxTokensPerPage** *number*

  The maximum number of tokens to extract per search result page (256-2048, default: 2048).

- **maxTokens** *number*

  The maximum total tokens across all search results (default: 25000, max: 1000000).

- **searchLanguageFilter** *string\[]*

  Filter search results by language using ISO 639-1 language codes (e.g., `['en']` for English, `['en', 'es']` for English and Spanish).

- **country** *string*

  Filter search results by country using ISO 3166-1 alpha-2 country codes (e.g., `'US'` for United States, `'GB'` for United Kingdom).

- **searchDomainFilter** *string\[]*

  Limit search results to specific domains (e.g., `['reuters.com', 'bbc.com']`). This is useful for restricting results to trusted sources.

- **searchRecencyFilter** *'day' | 'week' | 'month' | 'year'*

  Filter search results by relative time period. Useful for always getting recent results (e.g., 'week' for results from the last week).

The tool works with both `generateText` and `streamText`:

```ts
import { gateway, streamText } from "ai";

const result = streamText({
  model: "openai/gpt-5.4-nano",
  prompt: "Search for the latest news about AI regulations.",
  tools: {
    perplexity_search: gateway.tools.perplexitySearch(),
  },
});

for await (const part of result.fullStream) {
  switch (part.type) {
    case "text-delta":
      process.stdout.write(part.text);
      break;
    case "tool-call":
      console.log("\nTool call:", JSON.stringify(part, null, 2));
      break;
    case "tool-result":
      console.log("\nTool result:", JSON.stringify(part, null, 2));
      break;
  }
}
```

#### Parallel Search

The Parallel Search tool enables models to search the web using [Parallel AI's Search API](https://docs.parallel.ai/api-reference/search/search). The model provides a research objective and a few keyword queries, and the tool returns relevant excerpts from web pages, optimized for LLM consumption.

```ts
import { gateway, generateText } from "ai";

const result = await generateText({
  model: "openai/gpt-5.4-nano",
  prompt: "Research the latest developments in quantum computing.",
  tools: {
    parallel_search: gateway.tools.parallelSearch(),
  },
});

console.log(result.text);
console.log("Tool calls:", JSON.stringify(result.toolCalls, null, 2));
console.log("Tool results:", JSON.stringify(result.toolResults, null, 2));
```

You can also configure the search with optional parameters:

```ts
import { gateway, generateText } from "ai";

const result = await generateText({
  model: "openai/gpt-5.4-nano",
  prompt: "Find detailed information about TypeScript 5.0 features.",
  tools: {
    parallel_search: gateway.tools.parallelSearch({
      mode: "advanced",
      location: "us",
      maxResults: 5,
      sourcePolicy: {
        includeDomains: ["typescriptlang.org", "github.com"],
      },
      excerpts: {
        maxCharsPerResult: 8000,
      },
    }),
  },
});

console.log(result.text);
console.log("Tool calls:", JSON.stringify(result.toolCalls, null, 2));
console.log("Tool results:", JSON.stringify(result.toolResults, null, 2));
```

The Parallel Search tool supports the following optional configuration options:

- **mode** *'turbo' | 'fast' | 'basic' | 'advanced'*

  Search mode. Defaults to `'basic'`. See the [AI Gateway web search docs](https://vercel.com/docs/ai-gateway/models-and-providers/web-search#using-parallel-search) for pricing.

  - `'turbo'` - Lowest latency, shorter excerpts. Supports English and Japanese only.
  - `'fast'` - Low latency, shorter excerpts.
  - `'basic'` - Balanced latency and excerpt depth (default).
  - `'advanced'` - Most thorough retrieval, higher latency.

  `'one-shot'` and `'agentic'` are deprecated but still accepted: `'one-shot'` runs as `'basic'` and `'agentic'` runs as `'advanced'`.

- **maxResults** *number*

  Maximum number of results to return (1-20). Defaults to 10 if not specified.

- **sourcePolicy** *object*

  Source policy for controlling which domains to include/exclude:

  - `includeDomains` - Domains or domain/path prefixes to include, such as `'wikipedia.org'` or `'docs.python.org/3'`. When set, `excludeDomains` is ignored.
  - `excludeDomains` - Domains or domain/path prefixes to exclude
  - `afterDate` - Only include results published on or after this date (`YYYY-MM-DD`)

  The include and exclude lists can hold up to 200 entries combined.

- **maxCharsTotal** *number*

  Maximum total characters across all result excerpts.

- **excerpts** *object*

  Excerpt configuration for controlling result length:

  - `maxCharsPerResult` - Maximum characters per result
  - `maxCharsTotal` - Deprecated; use the top-level `maxCharsTotal`

- **fetchPolicy** *object*

  Fetch policy for controlling content freshness:

  - `maxAgeSeconds` - Maximum age of cached content, in seconds, before a live fetch is attempted. Minimum 600; lower values are raised to 600.
  - `timeoutSeconds` - Timeout for a live fetch, in seconds. The gateway caps it to stay within its own tool timeout.
  - `disableCacheFallback` - Return an error instead of older cached content when a live fetch fails. Defaults to `false`.

- **location** *string*

  ISO 3166-1 alpha-2 country code to localize results, such as `'us'`. Invalid codes are ignored with a warning.

Each tool result contains a `search_id` and `results`, ordered by decreasing relevance, and may include a `session_id`. Each result has a `url`, a `title`, a `publish_date` (both may be `null`), and `excerpts` (an array of markdown strings). The result can also include `warnings`, for example when an invalid `location` is ignored.

The tool works with both `generateText` and `streamText`:

```ts
import { gateway, streamText } from "ai";

const result = streamText({
  model: "openai/gpt-5.4-nano",
  prompt: "Research the latest AI safety guidelines.",
  tools: {
    parallel_search: gateway.tools.parallelSearch(),
  },
});

for await (const part of result.fullStream) {
  switch (part.type) {
    case "text-delta":
      process.stdout.write(part.text);
      break;
    case "tool-call":
      console.log("\nTool call:", JSON.stringify(part, null, 2));
      break;
    case "tool-result":
      console.log("\nTool result:", JSON.stringify(part, null, 2));
      break;
  }
}
```

### Usage Tracking with User and Tags

Track usage per end-user and categorize requests with tags:

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "openai/gpt-5.4",
  prompt: "Summarize this document...",
  providerOptions: {
    gateway: {
      user: "user-abc-123", // Track usage for this specific end-user
      tags: ["document-summary", "premium-feature"], // Categorize for reporting
    } satisfies GatewayProviderOptions,
  },
});
```

This allows you to:

- View usage and costs broken down by end-user in your analytics
- Filter and analyze spending by feature or use case using tags
- Track which users or features are driving the most AI usage

#### Querying Spend Reports

Use the `getSpendReport()` method to query usage data programmatically. The reporting API is only available for Vercel Pro and Enterprise plans. For pricing, see the [Custom Reporting docs](https://vercel.com/docs/ai-gateway/capabilities/custom-reporting).

```ts
import { gateway } from "ai";

const report = await gateway.getSpendReport({
  startDate: "2026-03-01",
  endDate: "2026-03-25",
  groupBy: "model",
});

for (const row of report.results) {
  console.log(`${row.model}: $${row.totalCost.toFixed(4)}`);
}
```

The `getSpendReport()` method accepts the following parameters:

- **startDate** *string* - Start date in `YYYY-MM-DD` format (inclusive, required)
- **endDate** *string* - End date in `YYYY-MM-DD` format (inclusive, required)
- **groupBy** *string* - Aggregation dimension: `'day'` (default), `'user'`, `'model'`, `'tag'`, `'provider'`, or `'credential_type'`
- **datePart** *string* - Time granularity when `groupBy` is `'day'`: `'day'` or `'hour'`
- **userId** *string* - Filter to a specific user
- **model** *string* - Filter to a specific model (e.g. `'anthropic/claude-sonnet-4.5'`)
- **provider** *string* - Filter to a specific provider (e.g. `'anthropic'`)
- **credentialType** *string* - Filter by `'byok'` or `'system'` credentials
- **tags** *string\[]* - Filter to requests matching these tags

Each row in `results` contains a grouping field (matching your `groupBy` choice) and metrics:

- **totalCost** *number* - Total cost in USD
- **marketCost** *number* - Market cost in USD
- **inputTokens** *number* - Number of input tokens
- **outputTokens** *number* - Number of output tokens
- **cachedInputTokens** *number* - Number of cached input tokens
- **cacheCreationInputTokens** *number* - Number of cache creation input tokens
- **reasoningTokens** *number* - Number of reasoning tokens
- **requestCount** *number* - Number of requests

You can combine tracking and querying to analyze spend by tags you defined:

```ts
import type { GatewayProviderOptions } from '@ai-sdk/gateway';
import { gateway, streamText } from 'ai';

// 1. Make requests with tags
const result = streamText({
  model: gateway('anthropic/claude-haiku-5.5'),
  prompt: 'Summarize this quarter's results',
  providerOptions: {
    gateway: {
      tags: ['team:finance', 'feature:summaries'],
    } satisfies GatewayProviderOptions,
  },
});

// 2. Later, query spend filtered by those tags
const report = await gateway.getSpendReport({
  startDate: '2026-03-01',
  endDate: '2026-03-31',
  groupBy: 'tag',
  tags: ['team:finance'],
});

for (const row of report.results) {
  console.log(`${row.tag}: $${row.totalCost.toFixed(4)} (${row.requestCount} requests)`);
}
```

## Provider Options

The AI Gateway provider accepts provider options that control routing behavior and provider-specific configurations.

### Gateway Provider Options

You can use the `gateway` key in `providerOptions` to control how AI Gateway routes requests:

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  prompt: "Explain quantum computing",
  providerOptions: {
    gateway: {
      order: ["vertex", "anthropic"], // Try Vertex AI first, then Anthropic
      only: ["vertex", "anthropic"], // Only use these providers
    } satisfies GatewayProviderOptions,
  },
});
```

The following gateway provider options are available:

- **order** *string\[]*

  Specifies the sequence of providers to attempt when routing requests. The gateway will try providers in the order specified. If a provider fails or is unavailable, it will move to the next provider in the list.

  Example: `order: ['bedrock', 'anthropic']` will attempt Amazon Bedrock first, then fall back to Anthropic.

- **only** *string\[]*

  Restricts routing to only the specified providers. When set, the gateway will never route to providers not in this list, even if they would otherwise be available.

  Example: `only: ['anthropic', 'vertex']` will only allow routing to Anthropic or Vertex AI.

- **sort** *'cost' | 'ttft' | 'tps'*

  Sorts available providers by a performance or cost metric before routing. The gateway will try the best-scoring provider first and fall back through the rest in sorted order. If unspecified, providers are ordered using the gateway's default system ranking.

  - `'cost'` — lowest cost first
  - `'ttft'` — lowest time-to-first-token first
  - `'tps'` — highest tokens-per-second first

  When combined with `order`, the user-specified providers are promoted to the front while remaining providers follow the sorted order.

  Example: `sort: 'ttft'` will route to the provider with the fastest time-to-first-token.

  When `sort` is active, the response's `providerMetadata.gateway.routing.sort` object contains the sort option used, the resulting execution order, per-provider metric values, and any providers that were deprioritized.

- **models** *string\[]*

  Specifies fallback models to use when the primary model fails or is unavailable. The gateway will try the primary model first (specified in the `model` parameter), then try each model in this array in order until one succeeds.

  Example: `models: ['openai/gpt-5.4-nano', 'gemini-3-flash-preview']` will try the fallback models in order if the primary model fails.

- **user** *string*

  Optional identifier for the end user on whose behalf the request is being made. This is used for spend tracking and attribution purposes, allowing you to track usage per end-user in your application.

  Example: `user: 'user-123'` will associate this request with end-user ID "user-123" in usage reports.

- **tags** *string\[]*

  Optional array of tags for categorizing and filtering usage in reports. Useful for tracking spend by feature, prompt version, or any other dimension relevant to your application.

  Example: `tags: ['chat', 'v2']` will tag this request with "chat" and "v2" for filtering in usage analytics.

- **byok** *Record\<string, Array\<Record\<string, unknown>>>*

  Request-scoped BYOK (Bring Your Own Key) credentials to use for this request. When provided, any cached BYOK credentials configured in the gateway system are not considered. Requests may still fall back to use system credentials if the provided credentials fail.

  Each provider can have multiple credentials (tried in order). The structure is a record where keys are provider slugs and values are arrays of credential objects.

  Each credential can optionally include a `modelMappings` array to map AI Gateway model slugs to your deployment names (for example, custom Azure deployment names). If a BYOK request fails, the gateway falls back to system credentials using the default model name.

  Examples:

  - Single provider: `byok: { 'anthropic': [{ apiKey: 'sk-ant-...' }] }`
  - Multiple credentials: `byok: { 'vertex': [{ projectId: 'proj-1', privateKey: '...' }, { projectId: 'proj-2', privateKey: '...' }] }`
  - Multiple providers: `byok: { 'anthropic': [{ apiKey: '...' }], 'bedrock': [{ accessKeyId: '...', secretAccessKey: '...' }] }`
  - With model mappings: `byok: { 'azure': [{ apiKey: '...', resourceName: '...', modelMappings: [{ gatewayModelSlug: 'openai/gpt-5.4-nano', customModelId: 'my-deployment' }] }] }`

- **zeroDataRetention** *boolean*

  Restricts routing to providers with zero data retention agreements with Vercel for AI Gateway. BYOK credentials are skipped by default, since your provider agreements differ from Vercel's. When this filter is on, AI Gateway routes only to providers Vercel has ZDR agreements with for the model. If you have BYOK keys marked as ZDR, those keys are tried first, then AI Gateway falls back to its system credentials. You are responsible for the accuracy of that marking. Applies to both account-wide and request-level ZDR. The request fails if no ZDR-eligible credentials are available. Request-level ZDR is only available for Vercel Pro and Enterprise plans.

- **disallowPromptTraining** *boolean*

  Restricts routing requests to providers that have agreements with Vercel for AI Gateway to not use prompts for model training. If there are no providers available for the model that disallow prompt training, the request will fail. BYOK credentials are skipped when `disallowPromptTraining` is set to `true` to ensure that requests are only routed to providers that do not train on prompt data.

- **quotaEntityId** *string*

  The unique identifier for the entity against which quota is tracked. Used for quota management and enforcement purposes.

- **has** *Array\<'implicit-caching' | 'reasoning' | 'structured-output' | 'tool-use' | 'vision' | `quantization:${string}` | `!quantization:${string}`>*

  Restricts routing to provider models that have all of the specified capabilities. Applies to both BYOK and system credentials, since the capability is a property of the model rather than the credential. If no provider model for the requested model satisfies the capabilities, the request fails. Unsupported values are rejected.

  Supported capabilities:

  - `'implicit-caching'` — models that perform automatic (implicit) prompt caching.
  - `'reasoning'` — models that support reasoning.
  - `'structured-output'` — models that support schema-constrained output.
  - `'tool-use'` — models that support tool calling.
  - `'vision'` — models that accept image input.

  Weight-format conditions route on the serving provider's recorded weight format: `'quantization:fp8'` requires a provider serving fp8 weights, while `'!quantization:fp8'` excludes fp8 providers. A negated condition also matches providers whose weight format is not recorded, so exclusions remain usable while the catalog is populated.

  Example: `has: ['implicit-caching']` will only route to models that support implicit caching. Example: `has: ['vision']` will only route to models that accept image input. Example: `has: ['tool-use']` will only route to models that support tool calling. Example: `has: ['!quantization:fp8']` will only route to providers that do not serve fp8 weights.

- **providerTimeouts** *object*

  Per-provider timeouts for BYOK credentials in milliseconds. Controls how long to wait for a provider to start responding before falling back to the next available provider.

  Example: `providerTimeouts: { byok: { openai: 5000, anthropic: 2000 } }`

  For full details, see [Provider Timeouts](https://vercel.com/docs/ai-gateway/models-and-providers/provider-timeouts).

You can combine these options to have fine-grained control over routing and tracking:

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  prompt: "Write a haiku about programming",
  providerOptions: {
    gateway: {
      order: ["vertex"], // Prefer Vertex AI
      only: ["anthropic", "vertex"], // Only allow these providers
    } satisfies GatewayProviderOptions,
  },
});
```

#### Model Fallbacks Example

The `models` option enables automatic fallback to alternative models when the primary model fails:

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "openai/gpt-5.4", // Primary model
  prompt: "Write a TypeScript haiku",
  providerOptions: {
    gateway: {
      models: ["openai/gpt-5.4-nano", "gemini-3-flash-preview"], // Fallback models
    } satisfies GatewayProviderOptions,
  },
});

// This will:
// 1. Try openai/gpt-5.4 first
// 2. If it fails, try openai/gpt-5.4-nano
// 3. If that fails, try gemini-3-flash-preview
// 4. Return the result from the first model that succeeds
```

#### Zero Data Retention Example

Set `zeroDataRetention` to true to route requests to providers with zero data retention agreements with Vercel for AI Gateway. BYOK credentials are skipped by default, since your provider agreements differ from Vercel's. When this filter is on, AI Gateway routes only to providers Vercel has ZDR agreements with for the model. If you have BYOK keys marked as ZDR, those keys are tried first, then AI Gateway falls back to its system credentials. You are responsible for the accuracy of that marking. Applies to both account-wide and request-level ZDR. The request fails if no ZDR-eligible credentials are available. When `zeroDataRetention` is `false` or not specified, there is no enforcement of restricting routing. Request-level ZDR is only available for Vercel Pro and Enterprise plans.

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  prompt: "Analyze this sensitive document...",
  providerOptions: {
    gateway: {
      zeroDataRetention: true,
    } satisfies GatewayProviderOptions,
  },
});
```

#### Disallow Prompt Training Example

Set `disallowPromptTraining` to true to route requests to providers that have agreements with Vercel for AI Gateway to not use prompts for model training. If there are no providers available for the model that disallow prompt training, the request will fail. When `disallowPromptTraining` is `false` or not specified, there is no enforcement of restricting routing. BYOK credentials are skipped when `disallowPromptTraining` is set to `true` to ensure that requests are only routed to providers that do not train on prompt data.

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  prompt: "Analyze this proprietary business data...",
  providerOptions: {
    gateway: {
      disallowPromptTraining: true,
    } satisfies GatewayProviderOptions,
  },
});
```

#### Quota Entity ID Example

Set `quotaEntityId` to track and enforce quota against a specific entity. This is useful for multi-tenant applications where you need to manage quota at the entity level (e.g., per organization or team).

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  prompt: "Summarize this report...",
  providerOptions: {
    gateway: {
      quotaEntityId: "org-123",
    } satisfies GatewayProviderOptions,
  },
});
```

#### Filtering by Model Capability

Set `has` to restrict routing to provider models that have the specified capabilities. This applies to both BYOK and system credentials, since the capability is a property of the model rather than the credential. `'implicit-caching'` limits routing to models that perform automatic prompt caching, `'vision'` limits routing to models that accept image input, `'reasoning'` limits routing to models that support reasoning, `'structured-output'` limits routing to models that support schema-constrained output, and `'tool-use'` limits routing to models that support tool calling. Weight-format conditions (`'quantization:fp8'` to require, `'!quantization:fp8'` to exclude) limit routing by the serving provider's recorded weight format. If no provider model for the requested model satisfies the capabilities, the request fails.

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";

const { text } = await generateText({
  model: "openai/gpt-5.5",
  prompt: "Summarize this report...",
  providerOptions: {
    gateway: {
      has: ["implicit-caching"],
    } satisfies GatewayProviderOptions,
  },
});
```

Use `'vision'` when the request sends image input, so the gateway only routes to
provider models that can accept it:

```ts
import type { GatewayProviderOptions } from "@ai-sdk/gateway";
import { generateText } from "ai";
import fs from "node:fs";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  messages: [
    {
      role: "user",
      content: [
        { type: "text", text: "Describe the image in detail." },
        {
          type: "file",
          mediaType: "image/png",
          data: fs.readFileSync("./data/comic-cat.png"),
        },
      ],
    },
  ],
  providerOptions: {
    gateway: {
      has: ["vision"],
    } satisfies GatewayProviderOptions,
  },
});
```

### Provider-Specific Options

When using provider-specific options through AI Gateway, use the actual provider name (e.g. `anthropic`, `openai`, not `gateway`) as the key:

```ts
import type { AnthropicProviderOptions } from '@ai-sdk/anthropic';
import type { GatewayProviderOptions } from '@ai-sdk/gateway';
import { generateText } from 'ai';

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4.6",
  prompt: "Explain quantum computing",
  providerOptions: {
    gateway: {
      order: ["vertex", "anthropic"],
    } satisfies GatewayProviderOptions,
    anthropic: {
      thinking: { type: 'enabled', budgetTokens: 12000 },
    } satisfies AnthropicProviderOptions,
  },
});
```

This works with any provider supported by AI Gateway. Each provider has its own set of options - see the individual [provider documentation pages](/v5/providers/ai-sdk-providers) for details on provider-specific options.

### Available Providers

AI Gateway supports routing to 20+ providers.

For a complete list of available providers and their slugs, see the [AI Gateway documentation](https://vercel.com/docs/ai-gateway/provider-options#available-providers).

## Model Capabilities

Model capabilities depend on the specific provider and model you're using. For detailed capability information, see:

- [AI Gateway provider options](https://vercel.com/docs/ai-gateway/provider-options#available-providers) for an overview of available providers
- Individual [AI SDK provider pages](/v5/providers/ai-sdk-providers) for specific model capabilities and features

---

For a semantic overview of all documentation, see [/sitemap.md](/sitemap.md)

For an index of all available documentation, see [/llms.txt](/llms.txt)

For agent-facing discovery, including API and MCP surfaces, see [/agents.md](/agents.md)