PII | Prediction Guard

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

promptstring or list of stringsRequired

replacebooleanRequired

Whether to replace personal information.

replace_methodstringOptional

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

entity_listlist of stringsOptional

An array of entity types that the PII check should ignore.

Successful response.

idstring or null

Unique ID for the PII check.

objectstring or null

Type of object (pii_check).

createdinteger or null

Timestamp of when the PII check was created.

checkslist of objects or null

The set of vectorized data.

1	import requests
2
3	url = "https://{your-pg.api-domain}.com/PII"
4
5	payload = {
6	"prompt": "My email is [email protected] and my number is 954-123-4567.",
7	"replace": True,
8	"replace_method": "mask"
9	}
10	headers = {
11	"Authorization": "Bearer <token>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

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	}