Nvisy SDK for TypeScript

TypeScript client for the Nvisy multimodal redaction platform.

Nvisy detects and removes sensitive information across documents, images, and audio. It combines deterministic patterns, NER, computer vision, and LLM-driven classification into auditable, policy-driven pipelines built for regulated industries such as healthcare, legal, government, and financial services.

Warning

Active development: API not stable. This project is under active development. Public APIs, configuration shapes, and on-disk formats may change without notice between releases. Pin a specific version if you depend on this in production.

Installation

npm install @nvisy/sdk

Quick Start

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

const client = new Nvisy({ apiToken: "your-api-token" });

const account = await client.account.getAccount();
const workspaces = await client.workspaces.listWorkspaces();

The client accepts additional options:

const client = new Nvisy({
  apiToken: "your-api-token", // Required
  baseUrl: "https://api.nvisy.com", // Optional
  userAgent: "MyApp/1.0.0", // Optional
  withLogging: true, // Optional
  headers: { // Optional
    "X-Custom-Header": "value",
  },
});

Features

• Modern ES2022+ JavaScript target
• Full TypeScript support with strict typing
• Debug logging for development
• Individual module exports for optimal bundling

Deployment

The fastest way to get started is with Nvisy Cloud.

To run locally, see the nvisycom/runtime and nvisycom/server repositories.

Contributing

See CONTRIBUTING.md for development setup and contribution guidelines.

Changelog

See CHANGELOG.md for release notes and version history.

License

MIT License, see LICENSE.txt

Support

• Documentation: docs.nvisy.com
• Issues: github.com/nvisycom/sdk-ts/issues
• Email: [email protected]