Skip to main content
POST
Create a guardrail

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Body

application/json
name
string
required

Name for the new guardrail

Required string length: 1 - 200
Example:

"My New Guardrail"

allowed_models
string[] | null

Array of model identifiers (slug or canonical_slug accepted)

Minimum array length: 1
Example:
allowed_providers
string[] | null

List of allowed provider IDs

Minimum array length: 1
Example:
content_filter_builtins
object[] | null

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.

Example:
content_filters
object[] | null

Custom regex content filters to apply to request messages

Example:
description
string | null

Description of the guardrail

Maximum string length: 1000
Example:

"A guardrail for limiting API usage"

enforce_zdr
boolean | null
deprecated

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, 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.

Example:

false

enforce_zdr_anthropic
boolean | null

Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided.

Example:

false

enforce_zdr_google
boolean | null

Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided.

Example:

false

enforce_zdr_openai
boolean | null

Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided.

Example:

false

enforce_zdr_other
boolean | null

Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided.

Example:

false

ignored_models
string[] | null

Array of model identifiers to exclude from routing (slug or canonical_slug accepted)

Minimum array length: 1
Example:
ignored_providers
string[] | null

List of provider IDs to exclude from routing

Minimum array length: 1
Example:
limit_usd
number<double> | null

Spending limit in USD

Example:

50

reset_interval
enum<string> | null

Interval at which the limit resets (daily, weekly, monthly)

Available options:
daily,
weekly,
monthly,
null
Example:

"monthly"

workspace_id
string<uuid>

The workspace to create the guardrail in. Defaults to the default workspace if not provided.

Example:

"0df9e665-d932-5740-b2c7-b52af166bc11"

Response

Guardrail created successfully

data
object
required

The created guardrail

Example: