Create Custom Rule

Create a customer-owned AI_SIGNAL, REGEX, or REQUIRE_NEAR rule

POST /api/policies/rules

Create Custom Rule

cURL

curl --request POST \
  --url https://api.zerodrift.ai/api/policies/rules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "action": "<string>",
  "severity": "<string>",
  "prompt": "<string>",
  "keywords": [
    {}
  ],
  "regex_pattern": "<string>",
  "anchor": "<string>",
  "near": [
    {}
  ]
}
'

Create a custom rule that belongs to your account. Supports AI_SIGNAL, REGEX, and REQUIRE_NEAR rule types. Requires a full-access API key.

Created rules start active and run on subsequent validations for your API key.

Request Body

The body is a discriminated union on type. Shared fields:

name · string · required

Human-readable rule name

type · string · required

AI_SIGNAL, REGEX, or REQUIRE_NEAR

action · string · required

fix or flag

severity · string · required

do_not_send or send_with_caution

suggested_text · string

Editable suggested replacement or warning guidance. Omit to allow warning fallback; null clears and suppresses warning fallback.

fix_note · string

Optional remediation guidance

AI_SIGNAL fields

prompt · string · required

AI instruction for the signal

keywords · array · required

Keyword gate (at least one string)

window · string · default: "document"

sentence, paragraph, or document

REGEX fields

regex_pattern · string · required

Raw Python regex (max 512 chars)

REQUIRE_NEAR fields

anchor · string · required

Raw Python regex for the anchor pattern (max 512 chars)

near · array · required

Raw Python regex patterns checked near the anchor

distance_chars · integer · default: "100"

Character distance around the anchor

direction · string · default: "either"

before, after, or either

case_insensitive · boolean · default: "false"

Case-insensitive matching

mode · string · default: "document"

document or page

min_hits · integer · default: "1"

Minimum near-pattern hits required

Response

Returns the created custom rule (CustomRuleResponse), including rule_id, source: "custom", active, timestamps, and type-specific fields.

Errors

Status	Meaning
400	Invalid custom rule payload
403	Full-access API key required

Example

cURL (REGEX)

curl -X POST "https://api.zerodrift.ai/api/policies/rules" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Block SSN patterns",
    "type": "REGEX",
    "action": "flag",
    "severity": "do_not_send",
    "regex_pattern": "\\b\\d{3}-\\d{2}-\\d{4}\\b"
  }'