---
title: "CreateBYOKKeyRequest"
---

## Fields

| Field                                                                                                                            | Type                                                                                                                             | Required                                                                                                                         | Description                                                                                                                      | Example                                                                                                                          |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `allowed_models`                                                                                                                 | List[*str*]                                                                                                                      | :heavy_minus_sign:                                                                                                               | Optional allowlist of model slugs this credential may be used for. `null` means no restriction.                                  | null                                                                                                                             |
| `allowed_user_ids`                                                                                                               | List[*str*]                                                                                                                      | :heavy_minus_sign:                                                                                                               | Optional allowlist of user IDs that may use this credential. `null` means no restriction.                                        | null                                                                                                                             |
| `disabled`                                                                                                                       | *Optional[bool]*                                                                                                                 | :heavy_minus_sign:                                                                                                               | Whether this credential should be created in a disabled state.                                                                   | false                                                                                                                            |
| `is_fallback`                                                                                                                    | *Optional[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`                                                                                                                            | *str*                                                                                                                            | :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[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                                                                                                                           |
| `workspace_id`                                                                                                                   | *Optional[str]*                                                                                                                  | :heavy_minus_sign:                                                                                                               | Optional workspace ID. Defaults to the authenticated entity's default workspace.                                                 | 550e8400-e29b-41d4-a716-446655440000                                                                                             |