TypeScript SDKAPI ReferenceModels

GetBYOKKeyResponse - TypeScript SDK

GetBYOKKeyResponse type definition

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

Example Usage

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

Fields

FieldTypeRequiredDescriptionExample
datamodels.BYOKKey✔️N/A{"allowed_api_key_hashes": null,"allowed_models": null,"allowed_user_ids": null,"created_at": "2025-08-24T10:30:00Z","disabled": false,"id": "11111111-2222-3333-4444-555555555555","is_fallback": false,"label": "sk-...AbCd","name": "Production OpenAI Key","provider": "openai","sort_order": 0,"workspace_id": "550e8400-e29b-41d4-a716-446655440000"}