> ## Documentation Index
> Fetch the complete documentation index at: https://openrouter-d02e98a0-mintlify-7021d5f4.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# BYOKKey - Python SDK

> BYOKKey method reference

<Warning>
  The Python SDK and docs are currently in beta.
  Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues).
</Warning>

## Fields

| Field                    | Type                                                                                         | Required             | Description                                                                                                                      | Example                                                                           |
| ------------------------ | -------------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `allowed_api_key_hashes` | List\[*str*]                                                                                 | :heavy\_check\_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction.     | \[<br />"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"<br />] |
| `allowed_models`         | List\[*str*]                                                                                 | :heavy\_check\_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction.                                  | `<nil>`                                                                           |
| `allowed_user_ids`       | List\[*str*]                                                                                 | :heavy\_check\_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction.                                        | `<nil>`                                                                           |
| `created_at`             | *str*                                                                                        | :heavy\_check\_mark: | ISO timestamp of when the credential was created.                                                                                | 2025-08-24T10:30:00Z                                                              |
| `disabled`               | *bool*                                                                                       | :heavy\_check\_mark: | Whether this credential is currently disabled.                                                                                   | false                                                                             |
| `id`                     | *str*                                                                                        | :heavy\_check\_mark: | Stable public identifier for this BYOK credential.                                                                               | 11111111-2222-3333-4444-555555555555                                              |
| `is_fallback`            | *bool*                                                                                       | :heavy\_check\_mark: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.      | false                                                                             |
| `label`                  | *str*                                                                                        | :heavy\_check\_mark: | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI.                              | sk-...AbCd                                                                        |
| `name`                   | *OptionalNullable\[str]*                                                                     | :heavy\_minus\_sign: | Optional human-readable name for the credential.                                                                                 | Production OpenAI Key                                                             |
| `provider`               | [components.BYOKProviderSlug](/client-sdks/python/api-reference/components/byokproviderslug) | :heavy\_check\_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai                                                                            |
| `sort_order`             | *int*                                                                                        | :heavy\_check\_mark: | Position within the provider — credentials are tried in ascending sort order.                                                    | 0                                                                                 |
| `workspace_id`           | *str*                                                                                        | :heavy\_check\_mark: | ID of the workspace this credential belongs to.                                                                                  | 550e8400-e29b-41d4-a716-446655440000                                              |