--- title: "Python API reference" canonical_url: "https://www.nutrient.io/api/python/" md_url: "https://www.nutrient.io/api/python.md" last_updated: "2026-06-15T11:02:36.126Z" description: "Complete API reference for Nutrient Python SDK" --- Complete API reference for Nutrient Python SDK. ## Installation ```bash pip install nutrient-sdk ``` ## Quick start ```python from nutrient_sdk import Document # Open a PDF and convert it to a Word document with Document.open("input.pdf") as document: document.export_as_word("output.docx") print("Successfully converted to output.docx") ``` ## Classes | Class | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------- | | [`Document`](./document/) | Represents a document that can be opened, edited, and exported in various formats. Provides a uni... | | [`License`](./license/) | Manages licensing for the Nutrient Native SDK. Provides methods to register license keys and trac... | | [`Vision`](./vision/) | Provides machine learning and computer vision capabilities for document processing. Enables AI-po... | ## Modules | Module | 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/) | SDK-specific exception classes raised by operations that can fail | | [`exporters`](./exporters/) | Exporters for PDF, image, Markdown, HTML, SVG, Word, spreadsheet, and presentation formats | | [`interfaces`](./interfaces/) | Interface definitions implemented by SDK types | | [`requests`](./requests/) | Classes in the requests module | | [`settings`](./settings/) | Configuration objects controlling SDK behavior | | [`signing`](./signing/) | Digital signatures, appearance, and timestamp configuration | | [`types`](./types/) | Primitive value types (Color, Rectf, Vec2f) | ## Statistics - **Classes:** 114 - **Enumerations:** 36 ## Additional resources - [Getting Started Guide](/sdk/python/getting-started.md) - [Code Examples](/guides/python/downloads.md) --- ## Related pages - [Document](/api/python/document.md) - [License](/api/python/license.md) - [Vision](/api/python/vision.md) ## Pages in this section - [All public classes import directly from the top-level package:](/api/python/editors.md) - [Word Editor](/api/python/editors/word-editor.md) - [Pdf Editor](/api/python/editors/pdf-editor.md) - [Access enum values](/api/python/enums/description-level.md) - [Access enum values](/api/python/enums/document-format.md) - [Access enum values](/api/python/enums/document-markup-mode.md) - [Access enum values](/api/python/enums/document-type.md) - [Access enum values](/api/python/enums/html-layout-type.md) - [Access enum values](/api/python/enums/image-export-format.md) - [Access enum values](/api/python/enums/image-setting-mode.md) - [Access enum values](/api/python/enums/image-export-mode.md) - [All public classes import directly from the top-level package:](/api/python/enums.md) - [Access enum values](/api/python/enums/implicit-conversion.md) - [Access enum values](/api/python/enums/json-export-content.md) - [Access enum values](/api/python/enums/document-bookmark-source.md) - [Access enum values](/api/python/enums/instant-json-render-theme.md) - [Access enum values](/api/python/enums/ocr-activation-mode.md) - [Access enum values](/api/python/enums/page-cache-mode.md) - [Access enum values](/api/python/enums/json-export-format.md) - [Access enum values](/api/python/enums/open-settings-mode.md) - [Access enum values](/api/python/enums/pdf-border-style.md) - [Access enum values](/api/python/enums/pdf-compression.md) - [Access enum values](/api/python/enums/pdf-conformance.md) - [Access enum values](/api/python/enums/pdf-form-field-type.md) - [Access enum values](/api/python/enums/pdf-line-ending-style.md) - [Access enum values](/api/python/enums/pdf-rubber-stamp-icon.md) - [Access enum values](/api/python/enums/pdf-page-sizes.md) - [Access enum values](/api/python/enums/pdf-save-preferences.md) - [Access enum values](/api/python/enums/rendering-layout-mode.md) - [Access enum values](/api/python/enums/pdf-settings-mode.md) - [Access enum values](/api/python/enums/tiff-compression.md) - [Access enum values](/api/python/enums/signature-hash-algorithm.md) - [Access enum values](/api/python/enums/text-direction.md) - [Access enum values](/api/python/enums/unit-mode.md) - [Access enum values](/api/python/enums/vision-engine.md) - [Access enum values](/api/python/enums/vision-features.md) - [Access enum values](/api/python/enums/vlm-classification-strategy.md) - [Access enum values](/api/python/enums/vision-output-format.md) - [Access enum values](/api/python/enums/vlm-provider.md) - [Access enum values](/api/python/enums/word-refining-method.md) - [Image Exporter](/api/python/exporters/image-exporter.md) - [Html Exporter](/api/python/exporters/html-exporter.md) - [Markdown Exporter](/api/python/exporters/markdown-exporter.md) - [All public classes import directly from the top-level package:](/api/python/exporters.md) - [Pdf Exporter](/api/python/exporters/pdf-exporter.md) - [Spreadsheet Exporter](/api/python/exporters/spreadsheet-exporter.md) - [Text Exporter](/api/python/exporters/text-exporter.md) - [Svg Exporter](/api/python/exporters/svg-exporter.md) - [Word Exporter](/api/python/exporters/word-exporter.md) - [Presentation Exporter](/api/python/exporters/presentation-exporter.md) - [Barcode Invalid Length Exception](/api/python/exceptions/barcode-invalid-length-exception.md) - [Barcode Invalid Data Exception](/api/python/exceptions/barcode-invalid-data-exception.md) - [Barcode Invalid Not Numeric Data Exception](/api/python/exceptions/barcode-invalid-not-numeric-data-exception.md) - [Barcode Exception](/api/python/exceptions/barcode-exception.md) - [Already Open For Edition Exception](/api/python/exceptions/already-open-for-edition-exception.md) - [Barcode Invalid Start Exception](/api/python/exceptions/barcode-invalid-start-exception.md) - [Barcode Invalid Stop Exception](/api/python/exceptions/barcode-invalid-stop-exception.md) - [Export Exception](/api/python/exceptions/export-exception.md) - [Barcode Invalid Type Exception](/api/python/exceptions/barcode-invalid-type-exception.md) - [Barcode Invalid Width Exception](/api/python/exceptions/barcode-invalid-width-exception.md) - [Implicit Conversion Exception](/api/python/exceptions/implicit-conversion-exception.md) - [File Not Found Exception](/api/python/exceptions/file-not-found-exception.md) - [Feature Un Licensed Exception](/api/python/exceptions/feature-un-licensed-exception.md) - [Incompatible Type Exception](/api/python/exceptions/incompatible-type-exception.md) - [Index Out Of Bounds Exception](/api/python/exceptions/index-out-of-bounds-exception.md) - [All public classes import directly from the top-level package:](/api/python/exceptions.md) - [Invalid License Exception](/api/python/exceptions/invalid-license-exception.md) - [Invalid Argument Exception](/api/python/exceptions/invalid-argument-exception.md) - [Invalid Settings Exception](/api/python/exceptions/invalid-settings-exception.md) - [Invalid State Exception](/api/python/exceptions/invalid-state-exception.md) - [Null Or Empty Parameter Exception](/api/python/exceptions/null-or-empty-parameter-exception.md) - [Invalid Template Exception](/api/python/exceptions/invalid-template-exception.md) - [Nutrient Argument Null Exception](/api/python/exceptions/nutrient-argument-null-exception.md) - [Unsupported Conversion](/api/python/exceptions/unsupported-conversion.md) - [Sdk Exception](/api/python/exceptions/sdk-exception.md) - [Vision Exception](/api/python/exceptions/vision-exception.md) - [All public classes import directly from the top-level package:](/api/python/interfaces.md) - [I Exporter](/api/python/interfaces/i-exporter.md) - [All public classes import directly from the top-level package:](/api/python/requests.md) - [Structured Extraction Request](/api/python/requests/structured-extraction-request.md) - [All public classes import directly from the top-level package:](/api/python/settings.md) - [Digital Signature Options](/api/python/signing/digital-signature-options.md) - [Signature Appearance](/api/python/signing/signature-appearance.md) - [Signature](/api/python/signing/signature.md) - [All public classes import directly from the top-level package:](/api/python/signing.md) - [Timestamp Configuration](/api/python/signing/timestamp-configuration.md) - [Color](/api/python/types/color.md) - [All public classes import directly from the top-level package:](/api/python/types.md) - [Advanced](/api/python/settings/advanced.md) - [Per-document override](/api/python/settings/document/open-settings.md) - [Per-document override](/api/python/settings/document/conversion-settings.md) - [Document](/api/python/settings/document.md) - [Document Settings](/api/python/settings/document/document-settings.md) - [Sdk Settings](/api/python/settings/document/sdk-settings.md) - [Per-document override](/api/python/settings/format/email-settings.md) - [Per-document override](/api/python/settings/format/cad-settings.md) - [Per-document override](/api/python/settings/format/html-settings.md) - [Format](/api/python/settings/format.md) - [Per-document override](/api/python/settings/format/jpeg-settings.md) - [Per-document override](/api/python/settings/format/word-settings.md) - [Per-document override](/api/python/settings/format/image-settings.md) - [Per-document override](/api/python/settings/format/spreadsheet-settings.md) - [Per-document override](/api/python/settings/format/pdf-settings.md) - [Per-document override](/api/python/settings/format/markdown-settings.md) - [Vision](/api/python/settings/vision.md) - [Per-document override](/api/python/settings/vision/vision-settings.md) - [All public classes import directly from the top-level package:](/api/python/editors/pdf/pages.md) - [Pdf Metadata](/api/python/editors/pdf/pages/pdf-metadata.md) - [Pdf Page Collection](/api/python/editors/pdf/pages/pdf-page-collection.md) - [Pdf Page](/api/python/editors/pdf/pages/pdf-page.md) - [All public classes import directly from the top-level package:](/api/python/editors/pdf/formfields.md) - [Pdf Combo Box Field](/api/python/editors/pdf/formfields/pdf-combo-box-field.md) - [Pdf Check Box Field](/api/python/editors/pdf/formfields/pdf-check-box-field.md) - [Pdf Form Field Collection](/api/python/editors/pdf/formfields/pdf-form-field-collection.md) - [Pdf Form Field](/api/python/editors/pdf/formfields/pdf-form-field.md) - [Pdf List Box Field](/api/python/editors/pdf/formfields/pdf-list-box-field.md) - [Pdf Push Button Field](/api/python/editors/pdf/formfields/pdf-push-button-field.md) - [Pdf Radio Button Field](/api/python/editors/pdf/formfields/pdf-radio-button-field.md) - [Pdf Signature Field](/api/python/editors/pdf/formfields/pdf-signature-field.md) - [Pdf Text Field](/api/python/editors/pdf/formfields/pdf-text-field.md) - [Format](/api/python/settings/advanced/format.md) - [Per-document override](/api/python/settings/advanced/format/instant-json-settings.md) - [Advanced](/api/python/settings/format/advanced.md) - [Per-document override](/api/python/settings/format/advanced/jbig2-settings.md) - [Per-document override](/api/python/settings/format/advanced/pdf-page-settings.md) - [Per-document override](/api/python/settings/format/advanced/tiff-settings.md) - [Per-document override](/api/python/settings/advanced/vision/ai-processing-settings.md) - [Per-document override](/api/python/settings/advanced/vision/custom-vlm-api-settings.md) - [Per-document override](/api/python/settings/advanced/vision/finalizer-settings.md) - [Per-document override](/api/python/settings/advanced/vision/form-labeling-settings.md) - [Per-document override](/api/python/settings/advanced/vision/form-recognition-settings.md) - [Vision](/api/python/settings/advanced/vision.md) - [Per-document override](/api/python/settings/advanced/vision/inference-layout-settings.md) - [Per-document override](/api/python/settings/advanced/vision/open-ai-languages-detection-settings.md) - [Per-document override](/api/python/settings/advanced/vision/ocr-settings.md) - [Per-document override](/api/python/settings/advanced/vision/open-ai-picture-alt-settings.md) - [Per-document override](/api/python/settings/advanced/vision/reading-order-settings.md) - [Per-document override](/api/python/settings/advanced/vision/segmenter-settings.md) - [Per-document override](/api/python/settings/advanced/vision/words-detection-settings.md) - [Per-document override](/api/python/settings/vision/advanced/claude-api-settings.md) - [Per-document override](/api/python/settings/vision/advanced/ai-augmenter-settings.md) - [Per-document override](/api/python/settings/vision/advanced/document-layout-json-export-settings.md) - [Per-document override](/api/python/settings/vision/advanced/deskew-settings.md) - [Per-document override](/api/python/settings/vision/advanced/content-extraction-settings.md) - [Per-document override](/api/python/settings/vision/advanced/handwriting-settings.md) - [Advanced](/api/python/settings/vision/advanced.md) - [Per-document override](/api/python/settings/vision/advanced/open-ai-api-endpoint-settings.md) - [Per-document override](/api/python/settings/vision/advanced/table-recognition-settings.md) - [Per-document override](/api/python/settings/vision/advanced/vision-descriptor-settings.md) - [All public classes import directly from the top-level package:](/api/python/editors/pdf/annotations.md) - [Pdf Annotation](/api/python/editors/pdf/annotations/pdf-annotation.md) - [Pdf Circle Annotation](/api/python/editors/pdf/annotations/pdf-circle-annotation.md) - [Pdf Annotation Collection](/api/python/editors/pdf/annotations/pdf-annotation-collection.md) - [Pdf Highlight Annotation](/api/python/editors/pdf/annotations/pdf-highlight-annotation.md) - [Pdf Line Annotation](/api/python/editors/pdf/annotations/pdf-line-annotation.md) - [Pdf Markup Annotation](/api/python/editors/pdf/annotations/pdf-markup-annotation.md) - [Pdf Link Annotation](/api/python/editors/pdf/annotations/pdf-link-annotation.md) - [Pdf Shape Annotation](/api/python/editors/pdf/annotations/pdf-shape-annotation.md) - [Pdf Redact Annotation](/api/python/editors/pdf/annotations/pdf-redact-annotation.md) - [Pdf Free Text Annotation](/api/python/editors/pdf/annotations/pdf-free-text-annotation.md) - [Pdf Square Annotation](/api/python/editors/pdf/annotations/pdf-square-annotation.md) - [Pdf Squiggly Annotation](/api/python/editors/pdf/annotations/pdf-squiggly-annotation.md) - [Pdf Stamp Annotation](/api/python/editors/pdf/annotations/pdf-stamp-annotation.md) - [Pdf Strike Out Annotation](/api/python/editors/pdf/annotations/pdf-strike-out-annotation.md) - [Pdf Underline Annotation](/api/python/editors/pdf/annotations/pdf-underline-annotation.md) - [Pdf Text Annotation](/api/python/editors/pdf/annotations/pdf-text-annotation.md) - [Pdf Widget Annotation](/api/python/editors/pdf/annotations/pdf-widget-annotation.md)