ai-gateway

Get virtual model config

Changed on

Get a virtual model config by path slug

get/ai-gateway/virtual-model-configs/{vmcSlug}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/ai-gateway/virtual-model-configs/{vmcSlug}
  • Auth: HTTP bearer

Path parameters

vmcSlugstring required

Query parameters

ownerIdstring
teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

allowFallbackFromFastfalse | true

Allow fallback from fast to standard providers on failure.

baseUrlstring

For kind=relay: URL the gateway forwards requests to as a transparent proxy.

byokCredentialIdsstring[]

BYOK credential IDs allowed for this VMC.

caching'auto'

Use caching if available.

createdAtnumber required

Creation timestamp (epoch ms).

createdBystring

User or app id that created this VMC.

deletedfalse | true required

Whether this VMC is soft-deleted.

descriptionstring

Optional description for UI.

disallowPromptTrainingfalse | true

Only use providers that will not train on your prompts.

displayNamestring

Human-readable name for UI.

hasstring[]

Limit providers to those with these features.

hipaaCompliantfalse | true

Only use HIPAA-compliant providers.

instanceIdstring

The concrete model-provider instance this VMC resolves to.

kindstring required

VMC kind: alias, relay, or router.

modelSlugstring

Canonical model slug this VMC maps to (e.g. "creator/model"). Not used by kind=router.

observabilityTagsstring[]

Observability tags attached to requests through this VMC.

ownerIdstring required

Team (owner) that owns this VMC.

providerOnlystring[]

Restrict routing to only these providers.

providerOptionsobject

Arbitrary per-provider AI SDK options, keyed by gateway provider slug.

providerOrderstring[]

Ordered list of providers to try as fallbacks on failure.

selector'cost' | 'tps' | 'ttft'

For kind=router: how to order candidates. Absent means declared order.

serviceTier'fast' | 'flex' | 'priority'

Service tier for providers that support it.

sort'cost' | 'latency' | 'price' | 'throughput' | 'tps' | 'ttft'

Rank eligible providers by an attribute.

speed'fast'

Only use fastest providers with short timeouts.

statusstring required

UI lifecycle status: draft, active, or archived.

updatedAtnumber required

Last update timestamp (epoch ms).

updatedBystring

User or app id that last updated this VMC.

virtualModelSlugstring required

Client-facing alias used as the model slug in Gateway calls.

visibilitystring

Visibility in listings: public, internal, or stealth.

zeroDataRetentionfalse | true

Only use providers with zero data retention.

Changes