Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
AllowedModels | optionalnullable.OptionalNullable[[]string] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. null means no restriction. | <nil> |
AllowedUserIds | optionalnullable.OptionalNullable[[]string] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. null means no restriction. | <nil> |
Disabled | *bool | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false |
IsFallback | *bool | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false |
Key | string | :heavy_check_mark: | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123… |
Name | optionalnullable.OptionalNullable[string] | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key |
Provider | components.BYOKProviderSlug | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, amazon-bedrock). | openai |
WorkspaceID | *string | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity’s default workspace. | 550e8400-e29b-41d4-a716-446655440000 |