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

​
Example Usage

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

let value: CreateBYOKKeyRequest = {
  key: "sk-proj-abc123...",
  provider: "openai",
};

​
Fields

FieldTypeRequiredDescriptionExample
allowedModelsstring[]:heavy_minus_sign:Optional allowlist of model slugs this credential may be used for. null means no restriction.<nil>
allowedUserIdsstring[]:heavy_minus_sign:Optional allowlist of user IDs that may use this credential. null means no restriction.<nil>
disabledboolean:heavy_minus_sign:Whether this credential should be created in a disabled state.false
isFallbackboolean:heavy_minus_sign:Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.false
keystring:heavy_check_mark:The raw provider API key or credential. This value is encrypted at rest and never returned in API responses.sk-proj-abc123…
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
workspaceIdstring:heavy_minus_sign:Optional workspace ID. Defaults to the authenticated entity’s default workspace.550e8400-e29b-41d4-a716-446655440000