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

​
Example Usage

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

let value: ListBYOKKeysResponse = {
  data: [
    {
      allowedApiKeyHashes: null,
      allowedModels: null,
      allowedUserIds: null,
      createdAt: "2025-08-24T10:30:00Z",
      disabled: false,
      id: "11111111-2222-3333-4444-555555555555",
      isFallback: false,
      label: "sk-...AbCd",
      provider: "openai",
      sortOrder: 0,
      workspaceId: "550e8400-e29b-41d4-a716-446655440000",
    },
  ],
  totalCount: 1,
};

​
Fields

FieldTypeRequiredDescriptionExample
datamodels.BYOKKey[]:heavy_check_mark:List of BYOK credentials.
totalCountnumber:heavy_check_mark:Total number of BYOK credentials matching the filters.1