Skip to content

Official JavaScript and TypeScript SDK for the platform, offering a modern, type-safe client with flexible configuration and seamless API integration.

License

Notifications You must be signed in to change notification settings

nvisycom/sdk-ts

Repository files navigation

Nvisy.com SDK for TypeScript/JavaScript

npm version build

Official TypeScript SDK for the Nvisy AI-powered document processing platform. Transform documents into usable data and apply intelligent edits with ease.

Features

  • Modern ES2022+ JavaScript target
  • Full TypeScript support with strict typing
  • Built-in environment variable support
  • Individual module exports for optimal bundling

Installation

npm install @nvisy/sdk

Usage

Basic Usage

Create a client with your API token:

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

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

const account = await client.account.get();
const projects = await client.projects.list();

Configuration Options

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

const client = new Client({
  apiToken: "your-api-token", // Required
  baseUrl: "https://api.nvisy.com", // Optional: API endpoint (default shown)
  userAgent: "MyApp/1.0.0", // Optional: custom user agent
  headers: { // Optional: custom headers
    "X-Custom-Header": "value",
  },
});

Changelog

See CHANGELOG.md for release notes and version history.

Contributing

See CONTRIBUTING.md for development guidelines.

License

MIT License - see LICENSE.txt for details.

Support

About

Official JavaScript and TypeScript SDK for the platform, offering a modern, type-safe client with flexible configuration and seamless API integration.

Topics

Resources

License

Contributing

Stars

Watchers

Forks