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

Example Usage

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

let value: UpdateBYOKKeyRequest = {};

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 is disabled.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_minus_sign:A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses.sk-proj-newkey456…
namestring:heavy_minus_sign:Optional human-readable name for the credential.Updated OpenAI Key