TypeScript SDK

The official TypeScript client for Nvisy is published on npm as @nvisy/sdk. It gives Node and browser applications a typed path to the redaction platform — detecting and removing sensitive information across documents, images, and audio — without hand-rolling requests against the REST API.

Install

npm install @nvisy/sdk

Getting Started

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 takes a few optional settings alongside the token:

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

• Full TypeScript support with strict typing throughout
• Modern ES2022+ target, shipped as ESM
• Debug logging for development
• Individual module exports for optimal bundling

Requirements

Node.js 20 or newer. The SDK is MIT licensed, and the source lives at nvisycom/sdk-ts.

For the full API surface, see the SDK documentation.