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
  • Python SDK
    • Overview
  • Go SDK
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
        • Models
        • BYOKKey
      • OAuth
      • Observability
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Fields
Go SDKAPI ReferenceModels

BYOKKey - Go SDK

BYOKKey type definition
Was this page helpful?
Previous

OAuth - Go SDK

OAuth method reference
Next
Built with

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

Fields

FieldTypeRequiredDescriptionExample
AllowedAPIKeyHashes[]string✔️Optional allowlist of OpenRouter API key hashes (api_keys.hash) that may use this credential. null means no restriction.[
“f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943”
]
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>
CreatedAtstring✔️ISO timestamp of when the credential was created.2025-08-24T10:30:00Z
Disabledbool✔️Whether this credential is currently disabled.false
IDstring✔️Stable public identifier for this BYOK credential.11111111-2222-3333-4444-555555555555
IsFallbackbool✔️Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.false
Labelstring✔️Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI.sk-…AbCd
Nameoptionalnullable.OptionalNullable[string]➖Optional human-readable name for the credential.Production OpenAI Key
Providercomponents.BYOKProviderSlug✔️The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, amazon-bedrock).openai
SortOrderint64✔️Position within the provider — credentials are tried in ascending sort order.0
WorkspaceIDstring✔️ID of the workspace this credential belongs to.550e8400-e29b-41d4-a716-446655440000