Python SDKAPI ReferenceComponents
CreateBYOKKeyRequest - Python SDK
CreateBYOKKeyRequest - Python SDK
CreateBYOKKeyRequest method reference
The Python SDK and docs are currently in beta. Report issues on GitHub.
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
allowed_models | List[str] | ➖ | Optional allowlist of model slugs this credential may be used for. null means no restriction. | <nil> |
allowed_user_ids | List[str] | ➖ | Optional allowlist of user IDs that may use this credential. null means no restriction. | <nil> |
disabled | Optional[bool] | ➖ | Whether this credential should be created in a disabled state. | false |
is_fallback | Optional[bool] | ➖ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false |
key | str | ✔️ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123… |
name | OptionalNullable[str] | ➖ | Optional human-readable name for the credential. | Production OpenAI Key |
provider | components.BYOKProviderSlug | ✔️ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, amazon-bedrock). | openai |
workspace_id | Optional[str] | ➖ | Optional workspace ID. Defaults to the authenticated entity’s default workspace. | 550e8400-e29b-41d4-a716-446655440000 |