Skip to main content
POST
/
api
/
v1
/
security
/
redact
Redact Content
curl --request POST \
  --url https://api.promptguard.dev/api/v1/security/redact \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": "<string>",
  "pii_types": [
    "<string>"
  ]
}
'
{
  "original": "<string>",
  "redacted": "<string>",
  "piiFound": [
    "<string>"
  ]
}

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

Specific PII types to redact (default: all)

Response

Successful Response

​
original
string
required
​
redacted
string
required
​
piiFound
string[]
required