This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /guides/web/about/operational-modes.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. Ways to use Nutrient Web SDK | Nutrient SDK

Nutrient Web SDK can be used in three common ways. The viewer API in your frontend is similar across these options, but authorization, document storage, and licensing differ. If you’re comparing licensed Web SDK with DWS Viewer API specifically, refer to the Web SDK vs. DWS Viewer API guide.

Web SDK with a license key

Use this path when your app owns document delivery and authorization. Web SDK loads documents directly in the browser using document and a Web SDK licenseKey.

This path works well when:

  • Your app already controls document access.
  • Documents should render directly in the browser.
  • You want fixed Web SDK licensing instead of DWS Viewer API usage-based viewer sessions.
  • You need browser-only operation without DWS authorization.

Web SDK with DWS Viewer API

Use this path when you want DWS Viewer API to authorize and meter viewer sessions. Your backend creates DWS Viewer API session tokens, and Web SDK loads with session.

DWS Viewer API supports two document sources:

  • DWS-managed documents uploaded to and stored by DWS.
  • App-provided documents with session and document.

For app-provided documents, omit licenseKey. The DWS Viewer API session authorizes the load. Backendless public API key support is planned separately; today, your backend creates the session.

Web SDK with self-hosted Document Engine

Use this path when you want to run Document Engine in your own infrastructure. Document Engine handles server-side storage, rendering, synchronization, and advanced processing, while Web SDK provides the browser UI.

This path works well when you:

  • Need to operate the backend yourself.
  • Want server-side document rendering and processing.
  • Need built-in annotation and form synchronization.
  • Need Document Engine features such as OCR and Instant collaboration.

Compare the options

OptionDocument sourceAuthorizationBackend
Web SDK with a license keyYour app provides documents to Web SDKWeb SDK license keyNone required
Web SDK with DWS Viewer APIDWS-managed documents or app-provided documentsDWS Viewer API sessionRequired today to create sessions
Web SDK with self-hosted Document EngineDocument Engine documentsDocument Engine JWTSelf-hosted Document Engine
FrameworkWeb SDKWeb SDK + Document Engine
Angular✓✓
ASP.NET✓✓
Blazor✓✓
Electron✓
HTML5✓✓
jQuery✓✓
Next.js✓✓
Nuxt.js✓✓
Progressive web apps✓✓
React✓✓
Ruby on Rails✓✓
Svelte✓✓
TypeScript✓✓
Vue✓✓
Flutter✓✓
PDF supportWeb SDKWeb SDK + Document Engine
PDF✓✓
PDF/A 1, 2, 3, 4✓✓
XFDF✓✓
Instant JSON✓✓
Office document supportWeb SDKWeb SDK + Document Engine
DOCX, DOC, DOTX, DOCM✓✓
PPTX, PPT, PPTM, PPSX✓✓
XLSX, XLS, XLSM✓✓
RTF✓
ODT✓
HTML supportWeb SDKWeb SDK + Document Engine
HTML✓
Image supportWeb SDKWeb SDK + Document Engine
PNG✓✓
JPEG, JPG✓✓
TIFF, TIF✓✓
HEIC✓
GIF✓
WebP✓
SVG✓
TGA✓
EPS✓
BMP✓
Email supportWeb SDKWeb SDK + Document Engine
EML✓
MSG✓
CAD supportWeb SDKWeb SDK + Document Engine
DWG✓
DXF✓
TXT supportWeb SDKWeb SDK + Document Engine
TXT✓✓

Next steps