--- title: "Nutrient .NET SDK API reference" canonical_url: "https://www.nutrient.io/api/csharp/" md_url: "https://www.nutrient.io/api/csharp.md" last_updated: "2026-10-08T08:55:57.713Z" description: "Classes, enumerations, and value types in the Nutrient .NET SDK." --- API reference for the Nutrient.NET SDK. All public types use the `Nutrient` namespace; the groups below organize the reference by feature. ## Installation ```bash dotnet add package Nutrient.SDK ``` ## Quick start ```csharp using Nutrient; using Document document = Document.Open("input.pdf"); document.ExportAsPdf("output.pdf"); ``` ## Classes | Class | Description | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`DataExtraction`](./data-extraction/) | Extracts data from a document with the same operations, the same option names and the same output files as the hosted Nutrient data extraction service, so code and knowledge carry over between the two. Like every SDK operation, each one reads its options from the document's settings: `ParseSettings` and `ExtractSettings`, generated from the hosted service's parameters, and the canonical settings they alias. Options left unset keep the default the pipeline or the SDK-wide settings provide. | | [`Document`](./document/) | Represents a document that can be opened, edited, and exported in various formats. Provides a unified interface for working with different document types including PDF, Word, Excel, and more. | | [`License`](./license/) | Manages licensing for the Nutrient Native SDK. Provides methods to register license keys and trace licensed features in evaluation mode (without registering a key). | | [`Query`](./query/) | Entry point for querying document content. A `Query` holds a built, in-memory search index over a document (or a file / folder / prebuilt index) and answers ranked text-search questions against it — the "index once, query many" model. Build one with the static `CreateIndex` / `CreateIndex` factories, then call `TextSearch` on the returned instance as often as you like. The ranking itself lives in the engine-independent `NativeSDK.Search` assembly; this licensed, bridge-exposed facade applies the entitlement gate and delegates. | | [`Telemetry`](./telemetry/) | Telemetry control surface used by the fiona CLI's send-only child mode. Lets a parent process dump proto payloads to disk via the `NUTRIENT_PAYLOAD_PATH` environment variable, exit fast, and have a short-lived child re-hydrate and ship them in parallel. | | [`Vision`](./vision/) | Provides machine learning and computer vision capabilities for document processing. Enables AI-powered document description and content extraction. | ## API groups | Group | Description | | ------------------------------------------------------- | -------------------------------------------------------------- | | [`editors`](./editors/) | Document editor classes for PDF and Word manipulation | | [`editors.pdf.annotations`](./editors/pdf/annotations/) | PDF annotation types (highlight, text, shape, stamp, and more) | | [`editors.pdf.formfields`](./editors/pdf/formfields/) | PDF form field types (text, check box, radio, list, signature) | | [`editors.pdf.pages`](./editors/pdf/pages/) | PDF page access, metadata, and page collections | | [`enums`](./enums/) | Enumeration types used across the SDK | | [`exceptions`](./exceptions/) | Errors reported by the C# SDK | | [`requests`](./requests/) | requests classes | | [`results`](./results/) | results classes | | [`settings`](./settings/) | Configuration objects controlling SDK behavior | | [`signing`](./signing/) | Digital signatures, appearance, and timestamp configuration | | [`types`](./types/) | Value types such as RectF and Vec2f | | [`validation`](./validation/) | validation classes | ## Coverage - 112 classes - 52 enumerations - 2 value types --- ## Related pages - [Data Extraction](/api/csharp/data-extraction.md) - [Document](/api/csharp/document.md) - [License](/api/csharp/license.md) - [Query](/api/csharp/query.md) - [Telemetry](/api/csharp/telemetry.md) - [Vision](/api/csharp/vision.md) ## Pages in this section - [Editors](/api/csharp/editors.md) - [Pdf Editor](/api/csharp/editors/pdf-editor.md) - [Presentation Editor](/api/csharp/editors/presentation-editor.md) - [Spreadsheet Editor](/api/csharp/editors/spreadsheet-editor.md) - [Word Editor](/api/csharp/editors/word-editor.md) - [Annotations](/api/csharp/editors/pdf/annotations.md) - [Pdf Annotation Collection](/api/csharp/editors/pdf/annotations/pdf-annotation-collection.md) - [Pdf Annotation](/api/csharp/editors/pdf/annotations/pdf-annotation.md) - [Pdf Circle Annotation](/api/csharp/editors/pdf/annotations/pdf-circle-annotation.md) - [Pdf Free Text Annotation](/api/csharp/editors/pdf/annotations/pdf-free-text-annotation.md) - [Pdf Highlight Annotation](/api/csharp/editors/pdf/annotations/pdf-highlight-annotation.md) - [Pdf Line Annotation](/api/csharp/editors/pdf/annotations/pdf-line-annotation.md) - [Pdf Link Annotation](/api/csharp/editors/pdf/annotations/pdf-link-annotation.md) - [Pdf Markup Annotation](/api/csharp/editors/pdf/annotations/pdf-markup-annotation.md) - [Pdf Redact Annotation](/api/csharp/editors/pdf/annotations/pdf-redact-annotation.md) - [Pdf Shape Annotation](/api/csharp/editors/pdf/annotations/pdf-shape-annotation.md) - [Pdf Square Annotation](/api/csharp/editors/pdf/annotations/pdf-square-annotation.md) - [Pdf Squiggly Annotation](/api/csharp/editors/pdf/annotations/pdf-squiggly-annotation.md) - [Pdf Stamp Annotation](/api/csharp/editors/pdf/annotations/pdf-stamp-annotation.md) - [Pdf Strike Out Annotation](/api/csharp/editors/pdf/annotations/pdf-strike-out-annotation.md) - [Pdf Text Annotation](/api/csharp/editors/pdf/annotations/pdf-text-annotation.md) - [Pdf Underline Annotation](/api/csharp/editors/pdf/annotations/pdf-underline-annotation.md) - [Pdf Widget Annotation](/api/csharp/editors/pdf/annotations/pdf-widget-annotation.md) - [Formfields](/api/csharp/editors/pdf/formfields.md) - [Pdf Check Box Field](/api/csharp/editors/pdf/formfields/pdf-check-box-field.md) - [Pdf Combo Box Field](/api/csharp/editors/pdf/formfields/pdf-combo-box-field.md) - [Pdf Form Field Collection](/api/csharp/editors/pdf/formfields/pdf-form-field-collection.md) - [Pdf Form Field](/api/csharp/editors/pdf/formfields/pdf-form-field.md) - [Pdf List Box Field](/api/csharp/editors/pdf/formfields/pdf-list-box-field.md) - [Pdf Push Button Field](/api/csharp/editors/pdf/formfields/pdf-push-button-field.md) - [Pdf Radio Button Field](/api/csharp/editors/pdf/formfields/pdf-radio-button-field.md) - [Pdf Signature Field](/api/csharp/editors/pdf/formfields/pdf-signature-field.md) - [Pdf Text Field](/api/csharp/editors/pdf/formfields/pdf-text-field.md) - [Pages](/api/csharp/editors/pdf/pages.md) - [Pdf Metadata](/api/csharp/editors/pdf/pages/pdf-metadata.md) - [Pdf Page Collection](/api/csharp/editors/pdf/pages/pdf-page-collection.md) - [Pdf Page](/api/csharp/editors/pdf/pages/pdf-page.md) - [Enums](/api/csharp/enums.md) - [Auto Tagging Engine](/api/csharp/enums/auto-tagging-engine.md) - [Description Level](/api/csharp/enums/description-level.md) - [Document Bookmark Source](/api/csharp/enums/document-bookmark-source.md) - [Document Format](/api/csharp/enums/document-format.md) - [Document Markup Mode](/api/csharp/enums/document-markup-mode.md) - [Document Type](/api/csharp/enums/document-type.md) - [Execution Provider](/api/csharp/enums/execution-provider.md) - [Form Vlm Enrichment Model](/api/csharp/enums/form-vlm-enrichment-model.md) - [Html Layout Type](/api/csharp/enums/html-layout-type.md) - [Image Export Format](/api/csharp/enums/image-export-format.md) - [Image Export Mode](/api/csharp/enums/image-export-mode.md) - [Image Setting Mode](/api/csharp/enums/image-setting-mode.md) - [Implicit Conversion](/api/csharp/enums/implicit-conversion.md) - [Inline Style Reference Mode](/api/csharp/enums/inline-style-reference-mode.md) - [Instant Json Render Theme](/api/csharp/enums/instant-json-render-theme.md) - [Json Export Content](/api/csharp/enums/json-export-content.md) - [Json Export Format](/api/csharp/enums/json-export-format.md) - [Ocr Activation Mode](/api/csharp/enums/ocr-activation-mode.md) - [Ocr Engine](/api/csharp/enums/ocr-engine.md) - [Open Settings Mode](/api/csharp/enums/open-settings-mode.md) - [Page Cache Mode](/api/csharp/enums/page-cache-mode.md) - [Paper Normalization Mode](/api/csharp/enums/paper-normalization-mode.md) - [Pdf Border Style](/api/csharp/enums/pdf-border-style.md) - [Pdf Compression](/api/csharp/enums/pdf-compression.md) - [Pdf Conformance](/api/csharp/enums/pdf-conformance.md) - [Pdf Form Field Type](/api/csharp/enums/pdf-form-field-type.md) - [Pdf Line Ending Style](/api/csharp/enums/pdf-line-ending-style.md) - [Pdf Page Sizes](/api/csharp/enums/pdf-page-sizes.md) - [Pdf Rubber Stamp Icon](/api/csharp/enums/pdf-rubber-stamp-icon.md) - [Pdf Save Preferences](/api/csharp/enums/pdf-save-preferences.md) - [Pdf Settings Mode](/api/csharp/enums/pdf-settings-mode.md) - [Pdf Validation Conformance](/api/csharp/enums/pdf-validation-conformance.md) - [Rendering Layout Mode](/api/csharp/enums/rendering-layout-mode.md) - [Restoration Mode](/api/csharp/enums/restoration-mode.md) - [Schema Compatibility](/api/csharp/enums/schema-compatibility.md) - [Search Display](/api/csharp/enums/search-display.md) - [Search Mode](/api/csharp/enums/search-mode.md) - [Signature Certification Level](/api/csharp/enums/signature-certification-level.md) - [Signature Format](/api/csharp/enums/signature-format.md) - [Signature Hash Algorithm](/api/csharp/enums/signature-hash-algorithm.md) - [Signature Key Source](/api/csharp/enums/signature-key-source.md) - [Signature Level](/api/csharp/enums/signature-level.md) - [Text Direction](/api/csharp/enums/text-direction.md) - [Tiff Compression](/api/csharp/enums/tiff-compression.md) - [Unit Mode](/api/csharp/enums/unit-mode.md) - [Unparseable Output Handling](/api/csharp/enums/unparseable-output-handling.md) - [Vision Engine](/api/csharp/enums/vision-engine.md) - [Vision Features](/api/csharp/enums/vision-features.md) - [Vision Output Format](/api/csharp/enums/vision-output-format.md) - [Vlm Classification Strategy](/api/csharp/enums/vlm-classification-strategy.md) - [Vlm Provider](/api/csharp/enums/vlm-provider.md) - [Word Refining Method](/api/csharp/enums/word-refining-method.md) - [Exceptions](/api/csharp/exceptions.md) - [Nutrient Exception](/api/csharp/exceptions/nutrient-exception.md) - [Requests](/api/csharp/requests.md) - [Classification Request](/api/csharp/requests/classification-request.md) - [Schema Generation Request](/api/csharp/requests/schema-generation-request.md) - [Structured Extraction Request](/api/csharp/requests/structured-extraction-request.md) - [Results](/api/csharp/results.md) - [Extract Result](/api/csharp/results/extract-result.md) - [Parse Result](/api/csharp/results/parse-result.md) - [Settings](/api/csharp/settings.md) - [Document](/api/csharp/settings/document.md) - [Conversion Settings](/api/csharp/settings/document/conversion-settings.md) - [Document Settings](/api/csharp/settings/document/document-settings.md) - [Open Settings](/api/csharp/settings/document/open-settings.md) - [Sdk Settings](/api/csharp/settings/document/sdk-settings.md) - [Advanced](/api/csharp/settings/document/advanced.md) - [Table Detection Settings](/api/csharp/settings/document/advanced/table-detection-settings.md) - [Format](/api/csharp/settings/format.md) - [Accessibility Settings](/api/csharp/settings/format/accessibility-settings.md) - [Cad Settings](/api/csharp/settings/format/cad-settings.md) - [Email Settings](/api/csharp/settings/format/email-settings.md) - [Html Settings](/api/csharp/settings/format/html-settings.md) - [Image Settings](/api/csharp/settings/format/image-settings.md) - [Jpeg Settings](/api/csharp/settings/format/jpeg-settings.md) - [Markdown Settings](/api/csharp/settings/format/markdown-settings.md) - [Pdf Settings](/api/csharp/settings/format/pdf-settings.md) - [Presentation Settings](/api/csharp/settings/format/presentation-settings.md) - [Search Settings](/api/csharp/settings/format/search-settings.md) - [Spreadsheet Settings](/api/csharp/settings/format/spreadsheet-settings.md) - [Text Settings](/api/csharp/settings/format/text-settings.md) - [Word Settings](/api/csharp/settings/format/word-settings.md) - [Advanced](/api/csharp/settings/format/advanced.md) - [Instant Json Settings](/api/csharp/settings/format/advanced/instant-json-settings.md) - [Jbig2 Settings](/api/csharp/settings/format/advanced/jbig2-settings.md) - [Pdf Page Settings](/api/csharp/settings/format/advanced/pdf-page-settings.md) - [Tiff Settings](/api/csharp/settings/format/advanced/tiff-settings.md) - [Vision](/api/csharp/settings/vision.md) - [Document Classification Settings](/api/csharp/settings/vision/document-classification-settings.md) - [Document Split Settings](/api/csharp/settings/vision/document-split-settings.md) - [Extract Settings](/api/csharp/settings/vision/extract-settings.md) - [Parse Settings](/api/csharp/settings/vision/parse-settings.md) - [Schema Generation Settings](/api/csharp/settings/vision/schema-generation-settings.md) - [Vision Settings](/api/csharp/settings/vision/vision-settings.md) - [Advanced](/api/csharp/settings/vision/advanced.md) - [Ai Augmenter Settings](/api/csharp/settings/vision/advanced/ai-augmenter-settings.md) - [Ai Processing Settings](/api/csharp/settings/vision/advanced/ai-processing-settings.md) - [Anthropic Api Settings](/api/csharp/settings/vision/advanced/anthropic-api-settings.md) - [Content Extraction Settings](/api/csharp/settings/vision/advanced/content-extraction-settings.md) - [Custom Vlm Api Settings](/api/csharp/settings/vision/advanced/custom-vlm-api-settings.md) - [Deskew Settings](/api/csharp/settings/vision/advanced/deskew-settings.md) - [Document Layout Json Export Settings](/api/csharp/settings/vision/advanced/document-layout-json-export-settings.md) - [Finalizer Settings](/api/csharp/settings/vision/advanced/finalizer-settings.md) - [Form Labeling Settings](/api/csharp/settings/vision/advanced/form-labeling-settings.md) - [Form Recognition Settings](/api/csharp/settings/vision/advanced/form-recognition-settings.md) - [Form Vlm Connection Settings](/api/csharp/settings/vision/advanced/form-vlm-connection-settings.md) - [Form Vlm Fallback Connection Settings](/api/csharp/settings/vision/advanced/form-vlm-fallback-connection-settings.md) - [Google Api Settings](/api/csharp/settings/vision/advanced/google-api-settings.md) - [Handwriting Settings](/api/csharp/settings/vision/advanced/handwriting-settings.md) - [Inference Layout Settings](/api/csharp/settings/vision/advanced/inference-layout-settings.md) - [Inline Style Settings](/api/csharp/settings/vision/advanced/inline-style-settings.md) - [Local Ai Processing Settings](/api/csharp/settings/vision/advanced/local-ai-processing-settings.md) - [Local Vlm Settings](/api/csharp/settings/vision/advanced/local-vlm-settings.md) - [Ocr Settings](/api/csharp/settings/vision/advanced/ocr-settings.md) - [Omr Settings](/api/csharp/settings/vision/advanced/omr-settings.md) - [Open Ai Api Endpoint Settings](/api/csharp/settings/vision/advanced/open-ai-api-endpoint-settings.md) - [Open Ai Languages Detection Settings](/api/csharp/settings/vision/advanced/open-ai-languages-detection-settings.md) - [Open Ai Picture Alt Settings](/api/csharp/settings/vision/advanced/open-ai-picture-alt-settings.md) - [Pp Text Det Settings](/api/csharp/settings/vision/advanced/pp-text-det-settings.md) - [Pp Text Rec Settings](/api/csharp/settings/vision/advanced/pp-text-rec-settings.md) - [Preprocessing Settings](/api/csharp/settings/vision/advanced/preprocessing-settings.md) - [Reading Order Settings](/api/csharp/settings/vision/advanced/reading-order-settings.md) - [Segmenter Settings](/api/csharp/settings/vision/advanced/segmenter-settings.md) - [Table Recognition Settings](/api/csharp/settings/vision/advanced/table-recognition-settings.md) - [Vision Acceleration Settings](/api/csharp/settings/vision/advanced/vision-acceleration-settings.md) - [Vision Descriptor Settings](/api/csharp/settings/vision/advanced/vision-descriptor-settings.md) - [Words Detection Settings](/api/csharp/settings/vision/advanced/words-detection-settings.md) - [Signing](/api/csharp/signing.md) - [Digital Signature Options](/api/csharp/signing/digital-signature-options.md) - [Pkcs11 Options](/api/csharp/signing/pkcs11-options.md) - [Signature Appearance](/api/csharp/signing/signature-appearance.md) - [Signature](/api/csharp/signing/signature.md) - [Timestamp Configuration](/api/csharp/signing/timestamp-configuration.md) - [Types](/api/csharp/types.md) - [Color](/api/csharp/types/color.md) - [Rect F](/api/csharp/types/rect-f.md) - [Vec2f](/api/csharp/types/vec2f.md) - [Validation](/api/csharp/validation.md) - [Pdf Validation Result](/api/csharp/validation/pdf-validation-result.md) - [Pdf Validator](/api/csharp/validation/pdf-validator.md)