---
title: "CreateGuardrailRequest"
---

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                              | Type                                                                                                                                                                                                                                                                                                                                                                               | Required                                                                                                                                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                        | Example                                                                                                                                                                                                                                                                                                                                                                            |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowed_models`                                                                                                                                                                                                                                                                                                                                                                   | List[*str*]                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Array of model identifiers (slug or canonical_slug accepted)                                                                                                                                                                                                                                                                                                                       | [<br/>"openai/gpt-5.2",<br/>"anthropic/claude-4.5-opus-20251124",<br/>"deepseek/deepseek-r1-0528:free"<br/>]                                                                                                                                                                                                                                                                       |
| `allowed_providers`                                                                                                                                                                                                                                                                                                                                                                | List[*str*]                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | List of allowed provider IDs                                                                                                                                                                                                                                                                                                                                                       | [<br/>"openai",<br/>"anthropic",<br/>"deepseek"<br/>]                                                                                                                                                                                                                                                                                                                              |
| `content_filter_builtins`                                                                                                                                                                                                                                                                                                                                                          | List[[components.ContentFilterBuiltinEntryInput](../components/contentfilterbuiltinentryinput.mdx)]                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Builtin content filters to apply. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only.                                                                                                                                                                  | [<br/>\{<br/>"action": "block",<br/>"slug": "regex-prompt-injection"<br/>}<br/>]                                                                                                                                                                                                                                                                                                    |
| `content_filters`                                                                                                                                                                                                                                                                                                                                                                  | List[[components.ContentFilterEntry](../components/contentfilterentry.mdx)]                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Custom regex content filters to apply to request messages                                                                                                                                                                                                                                                                                                                          | [<br/>\{<br/>"action": "redact",<br/>"label": "[API_KEY]",<br/>"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"<br/>}<br/>]                                                                                                                                                                                                                                                                  |
| `description`                                                                                                                                                                                                                                                                                                                                                                      | *OptionalNullable[str]*                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Description of the guardrail                                                                                                                                                                                                                                                                                                                                                       | A guardrail for limiting API usage                                                                                                                                                                                                                                                                                                                                                 |
| ~~`enforce_zdr`~~                                                                                                                                                                                                                                                                                                                                                                  | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false                                                                                                                                                                                                                                                                                                                                                                              |
| `enforce_zdr_anthropic`                                                                                                                                                                                                                                                                                                                                                            | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided.                                                                                                                                                                                                                                                                          | false                                                                                                                                                                                                                                                                                                                                                                              |
| `enforce_zdr_google`                                                                                                                                                                                                                                                                                                                                                               | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided.                                                                                                                                                                                                                                                                             | false                                                                                                                                                                                                                                                                                                                                                                              |
| `enforce_zdr_openai`                                                                                                                                                                                                                                                                                                                                                               | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided.                                                                                                                                                                                                                                                                             | false                                                                                                                                                                                                                                                                                                                                                                              |
| `enforce_zdr_other`                                                                                                                                                                                                                                                                                                                                                                | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided.                                                                                                                                                                                                                                | false                                                                                                                                                                                                                                                                                                                                                                              |
| `enforce_zdr_xai`                                                                                                                                                                                                                                                                                                                                                                  | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided.                                                                                                                                                                                                                                                                                | false                                                                                                                                                                                                                                                                                                                                                                              |
| `ignored_models`                                                                                                                                                                                                                                                                                                                                                                   | List[*str*]                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Array of model identifiers to exclude from routing (slug or canonical_slug accepted)                                                                                                                                                                                                                                                                                               | [<br/>"openai/gpt-4o-mini"<br/>]                                                                                                                                                                                                                                                                                                                                                   |
| `ignored_providers`                                                                                                                                                                                                                                                                                                                                                                | List[*str*]                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | List of provider IDs to exclude from routing                                                                                                                                                                                                                                                                                                                                       | [<br/>"azure"<br/>]                                                                                                                                                                                                                                                                                                                                                                |
| `limit_usd`                                                                                                                                                                                                                                                                                                                                                                        | *OptionalNullable[float]*                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Spending limit in USD                                                                                                                                                                                                                                                                                                                                                              | 50                                                                                                                                                                                                                                                                                                                                                                                 |
| `name`                                                                                                                                                                                                                                                                                                                                                                             | *str*                                                                                                                                                                                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                 | Name for the new guardrail                                                                                                                                                                                                                                                                                                                                                         | My New Guardrail                                                                                                                                                                                                                                                                                                                                                                   |
| `reset_interval`                                                                                                                                                                                                                                                                                                                                                                   | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx)                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | Interval at which the limit resets (daily, weekly, monthly)                                                                                                                                                                                                                                                                                                                        | monthly                                                                                                                                                                                                                                                                                                                                                                            |
| `workspace_id`                                                                                                                                                                                                                                                                                                                                                                     | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                 | The workspace to create the guardrail in. Defaults to the default workspace if not provided.                                                                                                                                                                                                                                                                                       | 0df9e665-d932-5740-b2c7-b52af166bc11                                                                                                                                                                                                                                                                                                                                               |