For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
ModelsChatRankingsDocs
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
    • Overview
    • Usage for Agents
  • TypeScript SDK
    • Overview
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
        • Models
        • ListBYOKKeysResponse
      • OAuth
      • Observability
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • Python SDK
    • Overview
  • Go SDK
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Example Usage
  • Fields
TypeScript SDKAPI ReferenceModels

ListBYOKKeysResponse - TypeScript SDK

ListBYOKKeysResponse type definition
Was this page helpful?
Previous

OAuth - TypeScript SDK

OAuth method reference
Next
Built with

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

Example Usage

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

Fields

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