CreateBYOKKeyRequest - TypeScript SDK

CreateBYOKKeyRequest type definition

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

Example Usage

1 import { CreateBYOKKeyRequest } from "@openrouter/sdk/models";
2 
3 let value: CreateBYOKKeyRequest = {
4   key: "sk-proj-abc123...",
5   provider: "openai",
6 };

Fields

Field	Type	Required	Description	Example
`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>`
`disabled`	boolean	➖	Whether this credential should be created in a disabled state.	false
`isFallback`	boolean	➖	Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.	false
`key`	string	✔️	The raw provider API key or credential. This value is encrypted at rest and never returned in API responses.	sk-proj-abc123…
`name`	string	➖	Optional human-readable name for the credential.	Production OpenAI Key
`provider`	models.BYOKProviderSlug	✔️	The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`).	openai
`workspaceId`	string	➖	Optional workspace ID. Defaults to the authenticated entity’s default workspace.	550e8400-e29b-41d4-a716-446655440000

1	import { CreateBYOKKeyRequest } from "@openrouter/sdk/models";
2
3	let value: CreateBYOKKeyRequest = {
4	key: "sk-proj-abc123...",
5	provider: "openai",
6	};