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

Unique ID for the PII check.

objectstring

Type of object (pii_check).

createdinteger

Timestamp of when the PII check was created.

checkslist of objects

The set of vectorized data.

400

Bad Request Error

403

Forbidden Error

$	curl -X POST https://{your-pg.api-domain}.com/PII \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"prompt": "My email is [email protected] and my number is 954-123-4567.",
>	"replace": true,
>	"replace_method": "mask"
>	}'

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	}

$	curl -X POST https://{your-pg.api-domain}.com/PII \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"prompt": "My email is [email protected] and my number is 954-123-4567.",
>	"replace": true,
>	"replace_method": "mask"
>	}'

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	}