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
        • CreateBYOKKeyRequest
      • 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

CreateBYOKKeyRequest - Go SDK

CreateBYOKKeyRequest 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
AllowedModelsoptionalnullable.OptionalNullable[[]string]➖Optional allowlist of model slugs this credential may be used for. null means no restriction.<nil>
AllowedUserIdsoptionalnullable.OptionalNullable[[]string]➖Optional allowlist of user IDs that may use this credential. null means no restriction.<nil>
Disabled*bool➖Whether this credential should be created in a disabled state.false
IsFallback*bool➖Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.false
Keystring✔️The raw provider API key or credential. This value is encrypted at rest and never returned in API responses.sk-proj-abc123…
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
WorkspaceID*string➖Optional workspace ID. Defaults to the authenticated entity’s default workspace.550e8400-e29b-41d4-a716-446655440000