Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

​
Example Usage

import { BYOKKey } from "@openrouter/sdk/models";

let value: BYOKKey = {
  allowedApiKeyHashes: null,
  allowedModels: null,
  allowedUserIds: null,
  createdAt: "2025-08-24T10:30:00Z",
  disabled: false,
  id: "11111111-2222-3333-4444-555555555555",
  isFallback: false,
  label: "sk-...AbCd",
  provider: "openai",
  sortOrder: 0,
  workspaceId: "550e8400-e29b-41d4-a716-446655440000",
};

​
Fields

FieldTypeRequiredDescriptionExample
allowedApiKeyHashesstring[]:heavy_check_mark:Optional allowlist of OpenRouter API key hashes (api_keys.hash) that may use this credential. null means no restriction.[
“f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943”
]
allowedModelsstring[]:heavy_check_mark:Optional allowlist of model slugs this credential may be used for. null means no restriction.<nil>
allowedUserIdsstring[]:heavy_check_mark:Optional allowlist of user IDs that may use this credential. null means no restriction.<nil>
createdAtstring:heavy_check_mark:ISO timestamp of when the credential was created.2025-08-24T10:30:00Z
disabledboolean:heavy_check_mark:Whether this credential is currently disabled.false
idstring:heavy_check_mark:Stable public identifier for this BYOK credential.11111111-2222-3333-4444-555555555555
isFallbackboolean:heavy_check_mark:Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.false
labelstring:heavy_check_mark:Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI.sk-…AbCd
namestring:heavy_minus_sign:Optional human-readable name for the credential.Production OpenAI Key
providermodels.BYOKProviderSlug:heavy_check_mark:The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, amazon-bedrock).openai
sortOrdernumber:heavy_check_mark:Position within the provider — credentials are tried in ascending sort order.0
workspaceIdstring:heavy_check_mark:ID of the workspace this credential belongs to.550e8400-e29b-41d4-a716-446655440000