Skip to content

docs: add model mappings to BYOK provider options #14310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
R-Taneja wants to merge 5 commits into
base: main
Choose a base branch
from
+5 −0
Open

docs: add model mappings to BYOK provider options #14310

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6ef257e
docs: add model mappings to BYOK provider options JSDoc
R-Taneja Apr 10, 2026
0ccf1ea
docs: add model mappings to AI Gateway provider docs
R-Taneja Apr 10, 2026
a8b3972
revert: remove JSDoc changes from gateway-provider-options.ts
R-Taneja Apr 10, 2026
53def0a
docs: fix model mappings wording to say 'your deployment names'
R-Taneja Apr 10, 2026
b28c783
docs: fix wording 'where you can use'
R-Taneja Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions content/providers/01-ai-sdk-providers/00-ai-gateway.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ You can connect your own provider credentials to use with Vercel AI Gateway. Thi

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
Expand Down Expand Up @@ -802,11 +804,14 @@ The following gateway provider options are available:

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': [{ project: 'proj-1', googleCredentials: { privateKey: '...', clientEmail: '...' } }, { project: 'proj-2', googleCredentials: { privateKey: '...', clientEmail: '...' } }] }`
- 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_

Expand Down
Loading