security

Scan text for personally identifiable information (PII/PHI/PCI) before passing it to an LLM or storing it.

Cost: 1 credit(s). Free tier: 10 calls per IP (no auth).

post/v1/scan/pii

Request

  • Base URL: https://api.agent-toolbox.ai
  • URL: https://api.agent-toolbox.ai/v1/scan/pii
  • Auth: one of:
    • HTTP bearer
    • none

Request body

textstring required
filenamestring

Response

Success.

verdict'PASS' | 'FLAG' | 'BLOCK' required
safeboolean required
scorenumber required
categoriesstring[] required
totalFindingsinteger required
redactedTextstring
certificatestring required

Tamper-evident SHA-256 certificate.

enforcementMode'block' | 'flag' | 'audit' required
filenamestring
latencyMsnumber required

Server compute time in ms.

Example response

{
  "certificate": "sha256:5bbf2510c504a1c1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.