For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
ModelsChatRankingsDocs
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
    • Overview
    • Usage for Agents
  • TypeScript SDK
    • Overview
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
        • Models
        • BYOKProviderSlug
      • OAuth
      • Observability
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • Python SDK
    • Overview
  • Go SDK
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Example Usage
  • Values
TypeScript SDKAPI ReferenceModels

BYOKProviderSlug - TypeScript SDK

BYOKProviderSlug type definition
Was this page helpful?
Previous

OAuth - TypeScript SDK

OAuth method reference
Next
Built with

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, amazon-bedrock).

Example Usage

1import { BYOKProviderSlug } from "@openrouter/sdk/models";
2
3let value: BYOKProviderSlug = "openai";
4
5// Open enum: unrecognized values are captured as Unrecognized<string>

Values

1"ai21" | "aion-labs" | "akashml" | "alibaba" | "amazon-bedrock" | "amazon-nova" | "ambient" | "anthropic" | "arcee-ai" | "atlas-cloud" | "avian" | "azure" | "baidu" | "baseten" | "black-forest-labs" | "byteplus" | "cerebras" | "chutes" | "cirrascale" | "clarifai" | "cloudflare" | "cohere" | "crusoe" | "deepinfra" | "deepseek" | "dekallm" | "featherless" | "fireworks" | "friendli" | "gmicloud" | "google-ai-studio" | "google-vertex" | "groq" | "hyperbolic" | "inception" | "inceptron" | "inference-net" | "infermatic" | "inflection" | "io-net" | "ionstream" | "liquid" | "mancer" | "mara" | "minimax" | "mistral" | "modelrun" | "modular" | "moonshotai" | "morph" | "ncompass" | "nebius" | "nex-agi" | "nextbit" | "novita" | "nvidia" | "open-inference" | "openai" | "parasail" | "perceptron" | "perplexity" | "phala" | "poolside" | "recraft" | "reka" | "relace" | "sambanova" | "seed" | "siliconflow" | "sourceful" | "stepfun" | "streamlake" | "switchpoint" | "together" | "upstage" | "venice" | "wandb" | "xai" | "xiaomi" | "z-ai" | Unrecognized<string>