# Viesus Docs

## Viesus-Docs (live)

- [Welcome](https://docs.viesus.com/readme.md): VIESUS delivers state-of-the-art quality on every image, scales with your production volume without becoming a bottleneck, and ensures results stay natural and consistent.
- [What is VIESUS?](https://docs.viesus.com/discover/what-is-viesus.md): A plain-language overview of the VIESUS image enhancement engine — what it is, who uses it, how it works, and what makes it different.
- [Key Features](https://docs.viesus.com/discover/key-features.md): VIESUS combines traditional image enhancement with AI-powered features for analysis, optimization, repair, upscaling, and composition.
- [Choose Your Interface](https://docs.viesus.com/discover/choose-your-interface.md): A decision guide for picking the right VIESUS interface — CLI, PDF Enhancer, Node.js module, C/C++ SDK, or Cloud API.
- [Image Quality](https://docs.viesus.com/features/features.md): Every VIESUS enhancement feature — automatic color, sharpening, face reconstruction, AI upscaling, background handling, and more.
- [Base Enhancement](https://docs.viesus.com/features/features/base-enhancement.md)
- [Global Color Correction](https://docs.viesus.com/features/features/global-color-correction.md)
- [Local Color Correction](https://docs.viesus.com/features/features/local-color-correction.md)
- [Skin Tone Enhancement](https://docs.viesus.com/features/features/skin-tone-enhancement.md)
- [Shadow & Highlight Recovery](https://docs.viesus.com/features/features/shadow-highlight-recovery.md)
- [Noise Reduction](https://docs.viesus.com/features/features/noise-reduction.md)
- [Sharpening](https://docs.viesus.com/features/features/sharpening.md)
- [Face Detection](https://docs.viesus.com/features/features/face-detection.md)
- [Face Reconstruction](https://docs.viesus.com/features/features/face-reconstruction.md)
- [Red-Eye Removal](https://docs.viesus.com/features/features/red-eye-removal.md)
- [AI Artifact Removal](https://docs.viesus.com/features/features/ai-artifact-removal.md)
- [AI Upscaling](https://docs.viesus.com/features/features/ai-super-resolution.md)
- [Background Handling](https://docs.viesus.com/features/features/background-handling.md)
- [Background Blur](https://docs.viesus.com/features/features/background-blur.md)
- [Grain Addition](https://docs.viesus.com/features/features/grain-addition.md)
- [Portrait Auto Cropping](https://docs.viesus.com/features/features/portrait-auto-cropping.md)
- [White Fix](https://docs.viesus.com/features/features/white-fix.md)
- [Adaptive Face Flash](https://docs.viesus.com/features/features/adaptive-face-flash.md)
- [ICC Color Management](https://docs.viesus.com/features/features/icc-color-management.md)
- [Monochrome & Sepia](https://docs.viesus.com/features/features/monochrome-sepia.md)
- [HDR Support](https://docs.viesus.com/features/hdr-support.md)
- [Scene-Based Enhancement](https://docs.viesus.com/features/scene-based-enhancement.md)
- [Native PDF Enhancement](https://docs.viesus.com/features/native-pdf-enhancement.md)
- [Image Formats](https://docs.viesus.com/features/image-formats.md)
- [Get a License](https://docs.viesus.com/get-started/get-a-license.md): VIESUS on-premise is commercially licensed. This page explains what to obtain from Viesus AG before installing.
- [Key Concepts](https://docs.viesus.com/get-started/key-concepts.md): The essential concepts behind VIESUS — one shared engine and configuration, how features are controlled, and GPU vs CPU.
- [Quickstart: Cloud](https://docs.viesus.com/get-started/quickstart-cloud.md): Enhance your first image within 5 minutes using the VIESUS Cloud . No installation required — just a free account and a web browser.
- [Quickstart: Image Enhancement](https://docs.viesus.com/get-started/quickstart-image-enhancement.md): Enhance your first image with the VIESUS CLI on Windows or Linux. From download to enhanced output in under 10 minutes.
- [Quickstart: PDF Enhancement](https://docs.viesus.com/get-started/quickstart-pdf-enhancer.md): Enhance your first PDF document with the VIESUS PDF Enhancer on Windows or Linux. From install to enhanced output in under 10 minutes.
- [System Requirements](https://docs.viesus.com/installation/requirements.md): Minimum and recommended hardware and software requirements for each VIESUS interface.
- [CLI & Viewer](https://docs.viesus.com/installation/cli.md): Install the VIESUS CLI and Viewer on Windows or Linux, including the CPU and GPU installer variants.
- [AI Add-ons](https://docs.viesus.com/installation/add-ons.md): Install the VIESUS AI Upscaling, Artifact Removal, and Background AI add-on installers on Windows.
- [PDF Enhancer](https://docs.viesus.com/installation/pdf.md): Install the VIESUS PDF Enhancer on Windows and Linux. Includes GPU and CPU variants, verification steps, and release notes.
- [Node.js Module](https://docs.viesus.com/installation/nodejs.md): Install the VIESUS Node.js native module on Ubuntu 22.04 with Node.js 18 and NVIDIA GPU support.
- [Updating](https://docs.viesus.com/installation/updating.md): Use the VIESUS Patch installer to update individual components, such as the Commandline tool, without a full reinstall.
- [Overview](https://docs.viesus.com/licensing/overview.md): VIESUS licensing models — on-premise GUID and Activation Key, plus credit-based Cloud API. How each works and how to choose.
- [GUID](https://docs.viesus.com/licensing/guid.md): GUID-based licensing for VIESUS on-premise products — machine-independent licensing, key properties, and how to pass the GUID at runtime.
- [Activation Key](https://docs.viesus.com/licensing/activation-key.md): Activation Key (Software Key) licensing for VIESUS — hardware-bound on-premise licensing, request file generation, and step-by-step activation.
- [VIESUS Viewer](https://docs.viesus.com/tools/viesus-viewer.md): The VIESUS Viewer is a Windows desktop application for visually tuning enhancement settings and testing configurations.
- [Folder Enhancer](https://docs.viesus.com/tools/folder-enhancer.md): The VIESUS Folder Enhancer is a Windows desktop application that watches hotfolders and automatically enhances images and PDFs as they arrive — no command line required.
- [Batch Processing](https://docs.viesus.com/use-cases/photo-lab-batch.md): How a high-volume photo lab enhances thousands of customer images per day with the VIESUS CLI — and which interface and settings fit the workflow.
- [PDF Processing](https://docs.viesus.com/use-cases/pdf-photobook-workflow.md): How a print platform enhances photobook and catalogue PDFs automatically with the VIESUS PDF Enhancer — and which interface and settings fit the workflow.
- [Node.js SaaS Integration](https://docs.viesus.com/use-cases/nodejs-saas.md): How a SaaS platform enhances user-uploaded images in the background with the VIESUS Node.js module — and which interface and settings fit the workflow.
- [Cloud API Integration](https://docs.viesus.com/use-cases/cloud-api-integration.md): How a web application enhances user-uploaded images with the VIESUS Cloud API — asynchronous, webhook-driven, no infrastructure — and which interface fits.
- [Docker Production Deployment](https://docs.viesus.com/use-cases/docker-production.md): How to run VIESUS enhancement as a containerized GPU microservice — which interface to containerize and what to plan for in production.
- [Overview](https://docs.viesus.com/configuration/overview.md)
- [Presets Gallery](https://docs.viesus.com/configuration/presets-gallery.md): Ready-to-use VIESUS enhancement preset configurations for common workflows. Download a JSON, drop it in, run.
- [Parameters](https://docs.viesus.com/configuration/parameter-reference.md): Complete reference for all viesusini.json parameters — Gpars, Lpars, Config, Resize, Background, ICCProfiles, AutoCrop, and Other.
- [Global Parameters](https://docs.viesus.com/configuration/parameter-reference/global-parameters.md): The Gpars section — global enhancement strengths, specialised AI strengths, and manual corrections applied to the whole image.
- [Local Parameters](https://docs.viesus.com/configuration/parameter-reference/local-parameters.md): The Lpars section — region correction factors and per-zone adjustments for skin, sky, and vegetation.
- [Mode Switches](https://docs.viesus.com/configuration/parameter-reference/mode-switches.md): The Config section — which processing stages run, plus the ARmode and HDRmode value tables and feature dependencies.
- [Resizing](https://docs.viesus.com/configuration/parameter-reference/resizing.md): The Resize section — image resizing, super-resolution, target dimensions, and the full list of resize mode values.
- [Background & Cropping](https://docs.viesus.com/configuration/parameter-reference/background-and-cropping.md): The Background section (replacement, color substitution, balance) and the AutoCrop section (portrait auto-cropping).
- [Output & Color](https://docs.viesus.com/configuration/parameter-reference/output-and-color.md): The Other section (output format, JPEG quality, DPI, monochrome/sepia) and the ICCProfiles section (output color profile).
- [PDF Settings](https://docs.viesus.com/configuration/pdf-settings.md): The PDF Enhancer's settings.json — general behavior, resizing, folders, triggers, file extensions, and special rendering modes.
- [General](https://docs.viesus.com/configuration/pdf-settings/general.md): General PDF Enhancer settings — core processing behavior, image filtering, adjacency, and soft-mask handling.
- [Resizing](https://docs.viesus.com/configuration/pdf-settings/resizing.md): PDF Enhancer resizing settings — image resizing, AI Upscaling, and artifact-removal modes for embedded images.
- [Folders & Triggers](https://docs.viesus.com/configuration/pdf-settings/folders-and-triggers.md): PDF Enhancer folder paths and the file-based trigger workflow for hotfolder processing.
- [File Extensions](https://docs.viesus.com/configuration/pdf-settings/file-extensions.md): PDF Enhancer naming conventions for processed and archived files.
- [Special Functions](https://docs.viesus.com/configuration/pdf-settings/special-functions.md): PDF Enhancer special rendering modes — Render to Image (RTI) and Render to PDF (RTPDF).
- [CLI Reference](https://docs.viesus.com/reference/cli-reference.md): Complete reference for the VIESUS image enhancement CLI — flags, input methods, output naming, image list format, and usage examples.
- [PDF CLI](https://docs.viesus.com/reference/pdf-cli.md): VIESUS PDF Enhancer (viesusPDF) reference — operating modes, all flags, processing workflow, and usage examples.
- [Node.js Module](https://docs.viesus.com/reference/node.js-module.md): VIESUS Node.js native module reference — installation, API, Docker, and performance tuning for in-process image enhancement.
- [Overview](https://docs.viesus.com/reference/node.js-module/overview.md): The VIESUS Node.js native module integrates the VIESUS image enhancement engine into Node.js environments on Linux. Overview, architecture, and requirements.
- [Getting Started](https://docs.viesus.com/reference/node.js-module/getting-started.md): A walkthrough of the worker.js and testbatch.js pattern for the VIESUS Node.js module — worker thread pool, batch processing, and GPU scaling.
- [API Reference](https://docs.viesus.com/reference/node.js-module/api-reference.md): Complete API reference for the VIESUS Node.js native module — MyViesusObject constructor, Enhance method, error codes, and result JSON.
- [Docker](https://docs.viesus.com/reference/docker.md): Run VIESUS in GPU-enabled Docker containers — guides for the CLI and the Node.js module.
- [Docker for CLI](https://docs.viesus.com/reference/docker/cli.md): Step-by-step guide to running the VIESUS CLI in a GPU-enabled Ubuntu Docker container with NVIDIA GPU support.
- [Docker for Node.js](https://docs.viesus.com/reference/docker/nodejs.md): Run the VIESUS Node.js module in a GPU-enabled Docker container. Dockerfile, build, and run instructions for Linux production deployments.
- [Cloud API](https://docs.viesus.com/reference/cloud-api.md): VIESUS Cloud GraphQL API reference — authentication, uploading, image and PDF enhancement, credits, and webhooks.
- [Overview](https://docs.viesus.com/reference/cloud-api/overview.md): VIESUS Cloud is a managed GraphQL API for image and PDF enhancement. No infrastructure required — upload, enhance, retrieve.
- [Authentication](https://docs.viesus.com/reference/cloud-api/authentication.md): Authenticate VIESUS Cloud API requests using the x-api-key header. Creating and managing API keys.
- [Uploading](https://docs.viesus.com/reference/cloud-api/uploading.md): Upload images and PDFs to VIESUS Cloud via URL or signed upload URL. Response fields, retention, and deletion.
- [Enhance Images](https://docs.viesus.com/reference/cloud-api/image-enhancement.md): Trigger image enhancements with createEnhancedImage. Parameters, status, AI upscaling limits, and polling vs webhooks.
- [Enhance PDFs](https://docs.viesus.com/reference/cloud-api/pdf-enhancement.md): Enhance PDFs via VIESUS Cloud. Analysis phase, enhancement parameters, DPI limits by subscription tier, and webhook events.
- [Credits](https://docs.viesus.com/reference/cloud-api/credits.md): VIESUS Cloud credit model — per-image pricing, PDF formulas, subscription DPI limits, and upload retention.
- [Webhooks](https://docs.viesus.com/reference/cloud-api/webhooks.md): Receive real-time enhancement notifications via VIESUS Cloud webhooks. Setup, signature verification, retry behavior, and delivery logs.
- [C/C++ SDK](https://docs.viesus.com/reference/overview.md): Integrate the VIESUS enhancement engine directly into C/C++ applications via the IsEnhance.h native API. When to use the SDK, platform support, and how to get access.
- [Performance Tuning](https://docs.viesus.com/operations/performance-tuning.md): Tune VIESUS throughput for CPU and GPU deployments — thread counts, configuration impact, image sizing, and benchmarking methodology.
- [Benchmarks](https://docs.viesus.com/operations/benchmarks.md): Reference throughput benchmarks for VIESUS across presets, the factors that affect performance, and how to size a deployment.
- [Monitoring](https://docs.viesus.com/operations/monitoring.md): Monitor VIESUS deployments — result files, error codes, log parsing, GPU metrics, and alerting patterns for on-premise and cloud.
- [Security](https://docs.viesus.com/operations/security.md): Security guidance for VIESUS deployments — GUID management, API key storage, network isolation, Docker security, and input validation.
- [FAQ](https://docs.viesus.com/support/faq.md): Answers to the most common questions about VIESUS — interfaces, licensing, features, configuration, integration, and troubleshooting.
- [Troubleshooting](https://docs.viesus.com/support/troubleshooting.md): Symptom-based fixes for VIESUS — first-run and install blockers, plus CLI, PDF Enhancer, Node.js module, and VIESUS Cloud issues.
- [Error Codes](https://docs.viesus.com/support/error-codes.md): Complete catalogue of error codes returned by VIESUS interfaces — CLI exit codes, PDF Enhancer error codes, and Node.js module return codes.
- [CLI Exit Codes](https://docs.viesus.com/support/error-codes/cli.md): Complete reference of VIESUS CLI exit codes — meanings, categories, and what to do for each.
- [PDF Enhancer Error Codes](https://docs.viesus.com/support/error-codes/pdf.md): Complete reference for all VIESUS PDF Enhancer error codes — meanings, causes, and fixes.
- [Node.js Error Codes](https://docs.viesus.com/support/error-codes/nodejs.md): Return codes from the VIESUS Node.js module — what each code means and when it occurs.
- [Changelog](https://docs.viesus.com/support/release-notes.md): VIESUS version history: what's new, what requires action, and feature additions per release.
- [VIESUS Assistant](https://docs.viesus.com/support/assistant.md): A downloadable skill that turns Claude — or another AI agent — into a VIESUS expert on your own machine: implementation, configuration, presets, error decoding, and parameter tuning.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.viesus.com/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.