Replace Personal Information

POST

Replace personal information such as names, SSNs, and emails in a given text.

This endpoint expects an object.

promptstringRequired

The prompt to check for personal information.

replacebooleanRequired

Whether to replace personal information.

replace_methodstringRequired

The method to use (random, fake, category, mask).

This endpoint returns an object.

idstringOptional

Unique ID for the chat completion.

objectstringOptional

Type of object (chat completion).

createdintegerOptional

Timestamp of when the chat completion was created.

checkslist of objectsOptional

The set of vectorized data.

1	curl -X POST https://api.predictionguard.com/PII \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"prompt": "My email is [email protected] and my number is 954-123-4567.",
6	"replace": true,
7	"replace_method": "mask"
8	}'

1	{
2	"id": "pii-MCZ68Tol2Laj0HgoJtvS5CaSljISkWN1",
3	"object": "pii_check",
4	"created": 1717675949,
5	"checks": [
6	{
7	"index": 0,
8	"new_prompt": "My email is * and my number is *.",
9	"status": "success"
10	}
11	]
12	}