Skip to main content
POST
Redact Content

Authorizations

X-API-Key
string
header
required

PromptGuard API key for developer endpoints. Keys start with pg_live_ and are created in the dashboard.

Headers

x-api-key
string | null

Body

application/json
content
string
required

Text to redact

Maximum string length: 100000
pii_types
string[] | null

Entity types to redact. Omit to use the policy's configured entities. Accepts detector entity names ('email', 'ssn', 'credit_card', 'phone_us'), the family aliases 'phone', 'ip_address' and 'passport', and 'api_key'. An unrecognized name is rejected rather than ignored.

Example:

Response

Successful Response

original
string
required
redacted
string
required
piiFound
string[]
required