> ## Documentation Index
> Fetch the complete documentation index at: https://openrouter.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# BYOKKey

## 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.                                                                                                                                                                                                         | null                                                                              |
| `allowed_user_ids`       | List\[*str*]                                                      | :heavy\_check\_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction.                                                                                                                                                                                                               | null                                                                              |
| `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_byok_only`           | *bool*                                                            | :heavy\_check\_mark: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials.                 | false                                                                             |
| `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. Cannot be combined with `is_byok_only`.                                                                                                                                     | false                                                                             |
| `is_required`            | *bool*                                                            | :heavy\_check\_mark: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. | 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](../components/byokproviderslug.mdx) | :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`           | *Nullable\[str]*                                                  | :heavy\_check\_mark: | The workspace this credential is scoped to, or `null` when it is global — usable across every workspace in the account. A `null` value does not mean the default workspace.                                                                                                                             | 550e8400-e29b-41d4-a716-446655440000                                              |