UpdateBYOKKeyRequest - TypeScript SDK
UpdateBYOKKeyRequest - TypeScript SDK
UpdateBYOKKeyRequest type definition
UpdateBYOKKeyRequest - TypeScript SDK
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
1 import { UpdateBYOKKeyRequest } from "@openrouter/sdk/models"; 2 3 let value: UpdateBYOKKeyRequest = {};
| 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 is disabled. | 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 | ➖ | 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… |
name | string | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key |