Classify

Detect personal or sensitive information within any given payload

post

/v1/classify

Authorizations

Body

contentstring · default: Hi, my name is John Doe, you can reach me on [e-mail]

Data you would like to classify

filtersstring[]

List of data elements to detect in the payload. If set to None, will detect all data elements Teleskope supports

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scanner.demo-001.teleskope.ai/v1/classify' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"content":"Hi, my name is John Doe, you can reach me on [e-mail]","filters":[null]}'

200

400

200

{
	"classifications": [
		{
			"data_element": "FIRST_NAME",
      "category": "PERSONAL",
			"star_char": 15,
			"char_size": 4,
		},
		{
			"data_element": "LAST_NAME",
      "category": "PERSONAL",
			"star_char": 20,
			"char_size": 3,
		},
		{
			"data_element": "EMAIL",
      "category": "PERSONAL",
			"star_char": 45,
			"char_size": 18,
		}
	]
}

200