APIs & SDKs
Get virtual model config
Get virtual model config
Get a virtual model config
AuthorizationbearerToken
Default authentication mechanism
GEThttps://api.vercel.com/v1/ai-gateway/virtual-model-configs
ownerId
The Team slug to perform the request on behalf of.
virtualModelSlug
limit
Optional
string
string
Optional
cursor
The Team identifier to perform the request on behalf of.
Optional
integer
Optional
string
Query parameters
slug
Optional
string
Optional
string
Response
200Success
Variant 1Variant 2
allowFallbackFromFast
boolean
Allow fallback from fast to standard providers on failure.
Optional
For kind=relay: URL the gateway forwards requests to as a transparent proxy.
baseUrl
byokCredentialIds
Optional
array
BYOK credential IDs allowed for this VMC.
Optional
caching
Use caching if available.
createdAt
Creation timestamp (epoch ms).
Optional description for UI.
number
Required
Required
deleted
description
boolean
string
Whether this VMC is soft-deleted.
Optional
Human-readable name for UI.
disallowPromptTraining
displayName
has
Optional
string
Optional
Only use providers that will not train on your prompts.
array
hipaaCompliant
Optional
Limit providers to those with these features.
Only use HIPAA-compliant providers.
Optional
inferenceRegion
Region pinned on the VMC for system-credential routing (alias/router only).
VMC kind: alias, relay, or router.
instanceId
object
Optional
string
Optional
kind
For kind=router: ordered candidates, model slugs or router references. Otherwise: fallback models.
The concrete model-provider instance this VMC resolves to.
Required
string
array
modelSlug
Canonical model slug this VMC maps to (e.g. "creator/model"). Not used by kind=router.
Optional
models
string
Optional
Team (owner) that owns this VMC.
observabilityTags
Restrict routing to only these providers.
Observability tags attached to requests through this VMC.
array
Optional
Required
ownerId
providerOnly
providerOptions
string
Optional
object
array
providerOrder
Arbitrary per-provider AI SDK options, keyed by gateway provider slug.
Optional
array
Optional
Ordered list of providers to try as fallbacks on failure.
providerTimeouts
For kind=router: capability tags a candidate must have.
requires
selector
Optional
Optional
Optional
Per-request provider timeouts in ms, keyed by provider slug for BYOK credentials.
serviceTier
string
string
Service tier for providers that support it.
For kind=router: how to order candidates.
Optional
updatedAt
Only use fastest providers with short timeouts.
Rank eligible providers by an attribute.
UI lifecycle status: draft, active, or archived.
Optional
Optional
virtualModelSlug
Required
Last update timestamp (epoch ms).
Visibility in listings: public, internal, or stealth.
number
Required
Optional
string
User id that last updated this VMC.
Client-facing alias used as the model slug in Gateway calls.
Required
Optional
boolean
Optional
Errors
400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error
500Error
This page is not in the current cross-link map.