BYOKKey Type | OpenRouter TypeScript SDK | OpenRouter

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

Example Usage

1 import { BYOKKey } from "@openrouter/sdk/models";
2 
3 let value: BYOKKey = {
4   allowedApiKeyHashes: null,
5   allowedModels: null,
6   allowedUserIds: null,
7   createdAt: "2025-08-24T10:30:00Z",
8   disabled: false,
9   id: "11111111-2222-3333-4444-555555555555",
10   isFallback: false,
11   label: "sk-...AbCd",
12   provider: "openai",
13   sortOrder: 0,
14   workspaceId: "550e8400-e29b-41d4-a716-446655440000",
15 };

Fields

Field	Type	Required	Description	Example
`allowedApiKeyHashes`	string[]	✔️	Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction.	[ “f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943” ]
`allowedModels`	string[]	✔️	Optional allowlist of model slugs this credential may be used for. `null` means no restriction.	`<nil>`
`allowedUserIds`	string[]	✔️	Optional allowlist of user IDs that may use this credential. `null` means no restriction.	`<nil>`
`createdAt`	string	✔️	ISO timestamp of when the credential was created.	2025-08-24T10:30:00Z
`disabled`	boolean	✔️	Whether this credential is currently disabled.	false
`id`	string	✔️	Stable public identifier for this BYOK credential.	11111111-2222-3333-4444-555555555555
`isFallback`	boolean	✔️	Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.	false
`label`	string	✔️	Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI.	sk-…AbCd
`name`	string	➖	Optional human-readable name for the credential.	Production OpenAI Key
`provider`	models.ProviderEnum	✔️	The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`).	openai
`sortOrder`	number	✔️	Position within the provider — credentials are tried in ascending sort order.	0
`workspaceId`	string	✔️	ID of the workspace this credential belongs to.	550e8400-e29b-41d4-a716-446655440000