BYOKKey - Go SDK
BYOKKey - Go SDK
BYOKKey type definition
The Go SDK and docs are currently in beta. Report issues on GitHub.
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
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> |
CreatedAt | string | ✔️ | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z |
Disabled | bool | ✔️ | Whether this credential is currently disabled. | false |
ID | string | ✔️ | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 |
IsFallback | bool | ✔️ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false |
Label | string | ✔️ | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-…AbCd |
Name | optionalnullable.OptionalNullable[string] | ➖ | Optional human-readable name for the credential. | Production OpenAI Key |
Provider | components.ProviderEnum | ✔️ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, amazon-bedrock). | openai |
SortOrder | int64 | ✔️ | Position within the provider — credentials are tried in ascending sort order. | 0 |
WorkspaceID | string | ✔️ | ID of the workspace this credential belongs to. | 550e8400-e29b-41d4-a716-446655440000 |
