PII Redaction | Plugins | AI Gateway

The pii_redaction plugin modifies request and response content directly. It runs on every matching request without needing a separate rule condition.

Use cases

Keeping names, emails, and account numbers out of third-party provider logs.
Meeting data-handling requirements without rewriting prompts in every service.
Sending sensitive support tickets to a model while preserving the reply for the end user.
Excluding raw PII from trace storage while still tracing the request end to end.

The pii_redaction plugin detects personally identifiable information in the request, replaces each value with a placeholder before the provider sees it, and restores the original values in the response. The provider receives only placeholders such as <EMAIL_ADDRESS_1> or <PERSON_2>.

This feature is in Beta.

Quick start

Add a pii_redaction entry to the plugins array.

curl -X POST https://api.orq.ai/v3/router/responses \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o-mini",
    "input": "Email the invoice to jane.doe@example.com",
    "plugins": [{ "id": "pii_redaction", "language": "en" }]
  }'

const response = await client.responses.create({
  model: 'openai/gpt-4o-mini',
  input: 'Email the invoice to jane.doe@example.com',
  // @ts-ignore - orq.ai extension
  plugins: [{ id: 'pii_redaction', language: 'en' }],
});

console.log(response.output_text);

response = client.responses.create(
    model="openai/gpt-4o-mini",
    input="Email the invoice to jane.doe@example.com",
    extra_body={
        "plugins": [{"id": "pii_redaction", "language": "en"}]
    },
)

print(response.output_text)

const response = await client.chat.completions.create({
  model: 'openai/gpt-4o-mini',
  messages: [
    { role: 'user', content: 'Email the invoice to jane.doe@example.com' },
  ],
  // @ts-ignore - orq.ai extension
  plugins: [{ id: 'pii_redaction', language: 'en' }],
});

Workspace-level redaction

Enable PII redaction for every request from Settings > Plugins, without passing a plugins array on each call. Once enabled, it applies automatically to every call that doesn’t already specify a pii_redaction plugin.

Plugins settings page with a PII Redaction card showing an enable toggle, and PDF Inputs and Response Healing cards labeled Coming soon. — The Plugins settings page showing the PII Redaction toggle, with PDF Inputs and Response Healing listed as coming soon.

Once the toggle is on, a icon appears next to it. Click it to open the Configuration panel.

A request cannot turn off or reduce the workspace-level redaction settings. It can only add stricter rules of its own, such as lowering the detection threshold to redact more.

How it works

The plugin runs a redaction round-trip around the generation:

Redact: detected PII in the request is replaced with typed placeholders before the request leaves the AI Gateway.
Generate: the provider processes the placeholder text and returns a response that keeps the placeholders intact.
Restore: the original values are substituted back into the response before it returns to the caller.

On embeddings, rerank, and images/generations, the plugin redacts the input only. The rerank response restores the echoed document text; embeddings and image generation have no echoed text to restore.

Detection runs on Orq.ai’s own model, hosted on Orq.ai infrastructure. Text is never sent to a third-party service for PII detection.

Configuration

Parameter	Type	Required	Description
`id`	string	Yes	Plugin discriminator. Must be `pii_redaction`.
`language`	string	No	Detector language: `en` or `nl`. Defaults to `en`.
`entities`	string[]	No	Restricts redaction to a subset of entity types. Omit to redact every type detected for the language.
`on_failure`	string	No	Behavior when redaction is unavailable: `block` or `passthrough`. Defaults to `block`.
`threshold`	number	No	Detector confidence cutoff in `[0,1]`. Defaults to `0.5`.
`persist_redacted_to_traces`	boolean	No	Store the redacted form in traces rather than the restored original. Defaults to `true`.

Detection threshold

The threshold parameter sets the confidence score at which a detected value is counted as PII. The range is 0 to 1; the default is 0.5.

Value	Behavior
`1`	Very high confidence required: fewer detections, more missed values.
`0`	Almost no confidence required: more detections, more false positives.

Scores are boosted for language-specific formats (for example, a Dutch BSN scores higher when the detected or selected language is Dutch). Adjust the threshold only when there is an observed problem: lower it if real PII is being missed, raise it if too many non-PII values are being redacted.

Restrict to specific entities

Pass entities to redact only the listed types. The list is case-insensitive and must match the selected language catalog.

curl -X POST https://api.orq.ai/v3/router/responses \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o-mini",
    "input": "Contact Jane Doe at jane.doe@example.com",
    "plugins": [{
      "id": "pii_redaction",
      "language": "en",
      "entities": ["EMAIL_ADDRESS"]
    }]
  }'

const response = await client.responses.create({
  model: 'openai/gpt-4o-mini',
  input: 'Contact Jane Doe at jane.doe@example.com',
  // @ts-ignore - orq.ai extension
  plugins: [
    { id: 'pii_redaction', language: 'en', entities: ['EMAIL_ADDRESS'] },
  ],
});

response = client.responses.create(
    model="openai/gpt-4o-mini",
    input="Contact Jane Doe at jane.doe@example.com",
    extra_body={
        "plugins": [{"id": "pii_redaction", "language": "en", "entities": ["EMAIL_ADDRESS"]}]
    },
)

Failure modes

The on_failure policy decides what happens when the detection service cannot run:

Mode	Behavior
`block`	Fails closed. The request is rejected and nothing reaches the provider. Default.
`passthrough`	Fails open. The original, un-redacted text is sent to the provider.

The detection service waits up to 90 seconds by default before timing out and applying the on_failure policy.

curl -X POST https://api.orq.ai/v3/router/responses \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o-mini",
    "input": "Email the invoice to jane.doe@example.com",
    "plugins": [{ "id": "pii_redaction", "language": "en", "on_failure": "passthrough" }]
  }'

const response = await client.responses.create({
  model: 'openai/gpt-4o-mini',
  input: 'Email the invoice to jane.doe@example.com',
  // @ts-ignore - orq.ai extension
  plugins: [{ id: 'pii_redaction', language: 'en', on_failure: 'passthrough' }],
});

response = client.responses.create(
    model="openai/gpt-4o-mini",
    input="Email the invoice to jane.doe@example.com",
    extra_body={
        "plugins": [{"id": "pii_redaction", "language": "en", "on_failure": "passthrough"}]
    },
)

Supported languages

The detectable entity catalog differs per language.

English (en)

Entity	Key	Description
Age	`AGE`	A person’s age
API key	`API_KEY`	Secret API credential
Bank routing number	`BANK_ROUTING`	Bank routing / ABA number
BIC / SWIFT	`BIC`	Bank identifier code
Biometric ID	`BIOMETRIC_ID`	Biometric identifier such as a fingerprint reference
Blood type	`BLOOD_TYPE`	A person’s blood type
BSN	`BSN`	Dutch citizen service number
Credit card	`CREDIT_CARD`	Credit or debit card number
Crypto wallet	`CRYPTO`	Cryptocurrency wallet address
Date / time	`DATE_TIME`	Dates and timestamps
Device ID	`DEVICE_ID`	Device identifier
Education level	`EDUCATION_LEVEL`	A person’s level of education
Email address	`EMAIL_ADDRESS`	Email address
Employment status	`EMPLOYMENT_STATUS`	A person’s employment status
Gender	`GENDER`	A person’s gender
Health plan ID	`HEALTH_PLAN_ID`	Health insurance plan identifier
HTTP cookie	`HTTP_COOKIE`	Browser cookie value
IBAN	`IBAN_CODE`	International bank account number
ID card	`ID_CARD`	National ID card number
Identifier	`ID`	Generic identifier
IMEI	`IMEI`	Mobile device IMEI
IP address	`IP_ADDRESS`	IPv4 or IPv6 address
Job title	`JOBTITLE`	A person’s job title
JWT	`JWT`	JSON Web Token
KVK number	`KVK_NUMBER`	Dutch chamber of commerce number
Language	`LANGUAGE`	Spoken or written language
License number	`LICENSE_NUMBER`	Generic license number
License plate	`LICENSE_PLATE`	Vehicle registration plate
Location	`LOCATION`	Place name or address
MAC address	`MAC_ADDRESS`	Network hardware address
Medical license	`MEDICAL_LICENSE`	Medical license number
Medical record	`MEDICAL_RECORD`	Medical record number
Nationality / religion / politics	`NRP`	Nationality, religious or political group
Organization	`ORGANIZATION`	Company or organization name
Passport	`PASSPORT`	Passport number
Password	`PASSWORD`	Password or secret
Person	`PERSON`	A person’s full name
Phone number	`PHONE_NUMBER`	Telephone number
PIN	`PIN`	Personal identification number
Political view	`POLITICAL_VIEW`	A person’s political affiliation
Race / ethnicity	`RACE_ETHNICITY`	A person’s race or ethnicity
Religious belief	`RELIGIOUS_BELIEF`	A person’s religion
Sexuality	`SEXUALITY`	A person’s sexual orientation
Tax ID	`TAX_ID`	Taxpayer identifier
Title	`TITLE`	Honorific or title
UK NHS number	`UK_NHS`	UK health service number
URL	`URL`	Web address
US bank account	`US_BANK_NUMBER`	US bank account number
US driver’s license	`US_DRIVER_LICENSE`	US driver’s license number
US ITIN	`US_ITIN`	US individual taxpayer identification number
US passport	`US_PASSPORT`	US passport number
US SSN	`US_SSN`	US social security number
UUID	`UUID`	Universally unique identifier
Vehicle ID	`VEHICLE_ID`	Vehicle identification number (VIN)

Dutch (nl)

Entity	Key	Description
Age	`AGE`	A person’s age
API key	`API_KEY`	Secret API credential
Bank routing number	`BANK_ROUTING`	Bank routing / ABA number
BIC / SWIFT	`BIC`	Bank identifier code
Biometric ID	`BIOMETRIC_ID`	Biometric identifier such as a fingerprint reference
Blood type	`BLOOD_TYPE`	A person’s blood type
BSN	`BSN`	Dutch citizen service number
Credit card	`CREDIT_CARD`	Credit or debit card number
Crypto wallet	`CRYPTO`	Cryptocurrency wallet address
Date / time	`DATE_TIME`	Dates and timestamps
Device ID	`DEVICE_ID`	Device identifier
Education level	`EDUCATION_LEVEL`	A person’s level of education
Email address	`EMAIL_ADDRESS`	Email address
Employment status	`EMPLOYMENT_STATUS`	A person’s employment status
Gender	`GENDER`	A person’s gender
Health plan ID	`HEALTH_PLAN_ID`	Health insurance plan identifier
HTTP cookie	`HTTP_COOKIE`	Browser cookie value
IBAN	`IBAN_CODE`	International bank account number
ID card	`ID_CARD`	National ID card number
Identifier	`ID`	Generic identifier
IMEI	`IMEI`	Mobile device IMEI
IP address	`IP_ADDRESS`	IPv4 or IPv6 address
KVK number	`KVK_NUMBER`	Dutch chamber of commerce number
Language	`LANGUAGE`	Spoken or written language
License number	`LICENSE_NUMBER`	Generic license number
License plate	`LICENSE_PLATE`	Vehicle registration plate
Location	`LOCATION`	Place name or address
MAC address	`MAC_ADDRESS`	Network hardware address
Medical record	`MEDICAL_RECORD`	Medical record number
Nationality / religion / politics	`NRP`	Nationality, religious or political group
Organization	`ORGANIZATION`	Company or organization name
Passport	`PASSPORT`	Passport number
Password	`PASSWORD`	Password or secret
Person	`PERSON`	A person’s full name
Phone number	`PHONE_NUMBER`	Telephone number
PIN	`PIN`	Personal identification number
Political view	`POLITICAL_VIEW`	A person’s political affiliation
Race / ethnicity	`RACE_ETHNICITY`	A person’s race or ethnicity
Religious belief	`RELIGIOUS_BELIEF`	A person’s religion
Sexuality	`SEXUALITY`	A person’s sexual orientation
Tax ID	`TAX_ID`	Taxpayer identifier
Title	`TITLE`	Honorific or title
URL	`URL`	Web address
US driver’s license	`US_DRIVER_LICENSE`	US driver’s license number
US SSN	`US_SSN`	US social security number
Vehicle ID	`VEHICLE_ID`	Vehicle identification number (VIN)

Tracing

Redaction is traced in-process as child spans of the request: pii-redact for the input pass and pii-restore for the output pass. Each span carries the configured language, the failure policy, the requested entity count, the placeholder count, and the outcome. persist_redacted_to_traces controls whether the redacted (placeholder) form or the restored original is stored in trace content; it defaults to true (redacted form stored).

Get Started

Models & Providers

Configuration

Observability

AI Gateway Features

PII Redaction | Plugins | AI Gateway

Use cases

Quick start

Workspace-level redaction

How it works

Configuration

Detection threshold

Restrict to specific entities

Failure modes

Supported languages

Tracing

​Use cases

​Quick start

​Workspace-level redaction

​How it works

​Configuration

​Detection threshold

​Restrict to specific entities

​Failure modes

​Supported languages

​Tracing

Use cases

Quick start

Workspace-level redaction

How it works

Configuration

Detection threshold

Restrict to specific entities

Failure modes

Supported languages

Tracing