Prerequisites
- An Nvisy account, or a self-hosted deployment
- An API token from API Tokens in your account settings
- A workspace — create one in the app, or with
POST /workspaces/
Install an SDK
Verify Your Connection
Redact a Document
Redaction is deliberately two-phase: a run first detects sensitive data, and nothing is modified until you apply redactions.1
Upload a file
2
Start a detection run
queued → analyzing → analyzed.3
Wait for detection to finish
Subscribe to the run’s event stream. It emits the current status
immediately, then each transition, and ends once the run settles.
4
Review what was found
5
Apply redactions
6
Download the result
Next Steps
Redaction Workflow
How detection and redaction fit together
API Reference
Every endpoint, generated from the spec
TypeScript SDK
Full API coverage
Audit Trails
Export run audits for archiving
