Quickstart

This guide takes you from an API token to a redacted document.

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

Export your token so the examples below can pick it up: export NVISY_API_TOKEN="..."

Install an SDK

npm install @nvisy/sdk

pip install nvisy-sdk

# Cargo.toml
nvisy-sdk = "0.1"

The TypeScript SDK has full API coverage and is the reference implementation. The Python and Rust SDKs currently provide configured HTTP clients.

Verify Your Connection

import { Nvisy } from "@nvisy/sdk";

const client = new Nvisy({ apiToken: process.env.NVISY_API_TOKEN! });

const workspaces = await client.workspaces.listWorkspaces();
console.table(
  workspaces.items.map(({ id, handle }) => ({ id, handle })),
);

curl https://api.nvisy.com/workspaces \
  -H "Authorization: Bearer $NVISY_API_TOKEN"

Workspaces, documents, pipelines, and detections are all addressed by id. A workspace’s handle is display-only — read the id from the listing above and use that in every call below.

Redact a Document

Redaction is deliberately two-phase: a detection first finds sensitive data, and nothing is modified until you redact.

Pick a workspace and pipeline

const { items: workspaces } = await client.workspaces.listWorkspaces();
const workspaceId = workspaces[0].id;

const { items: pipelines } = await client.pipelines.listPipelines(workspaceId);
if (pipelines.length === 0) {
  throw new Error(
    `Workspace ${workspaceId} has no pipelines — create one first.`,
  );
}
const pipelineId = pipelines[0].id;

A new workspace starts with no pipelines. Create one with client.pipelines.createPipeline(workspaceId, ...), or skip pipelines entirely and run an ad-hoc detection against a policy.

Upload a document

import { readFile } from "node:fs/promises";

const bytes = await readFile("./contract.pdf");

const [document] = await client.documents.uploadDocuments(
  workspaceId,
  new File([bytes], "contract.pdf", { type: "application/pdf" }),
);

Start a detection

const detection = await client.detections.createDetection(
  workspaceId,
  pipelineId,
  { documentId: document.id },
);

Detections move through pending → executing → complete.

Wait for analysis to finish

Subscribe to the detection’s event stream. It yields the current status immediately, then each transition, and ends once the detection settles.

let status = detection.status;

for await (const event of client.detections.streamEvents(
  workspaceId,
  detection.id,
)) {
  status = event.status;
}

if (status !== "complete") {
  throw new Error(`Detection ${detection.id} ended as ${status}`);
}

Review what was found

const audit = await client.detections.getAnalysis(workspaceId, detection.id);
console.log(audit.report);

Apply redactions

const redaction = await client.detections.createRedaction(
  workspaceId,
  detection.id,
  {},
);

console.log(redaction.id, redaction.outputDocumentId);

Pass { edits } instead of {} to layer reviewer changes over the analysis — suppressing a false positive, retagging an entity, or adding one the analysis missed.

Download the result

import { writeFile } from "node:fs/promises";

const response = await client.documents.downloadDocument(
  workspaceId,
  redaction.outputDocumentId!,
);

await writeFile(
  "./contract-redacted.pdf",
  Buffer.from(await response.arrayBuffer()),
);

To analyze a document without a saved pipeline, use client.detections.createAdhocDetection(workspaceId, { documentId, policyIds }) and name the policies directly.

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 detection audits for archiving

Overview

Features

Cloud

On-Premise

Prerequisites

Install an SDK

Verify Your Connection

Redact a Document

Next Steps

Redaction Workflow

API Reference

TypeScript SDK

Audit Trails

​Prerequisites

​Install an SDK

​Verify Your Connection

​Redact a Document

​Next Steps

Redaction Workflow

API Reference

TypeScript SDK

Audit Trails

Prerequisites

Install an SDK

Verify Your Connection

Redact a Document

Next Steps