This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/python.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. Python API reference

Python API reference

Markdown version of this page, suitable for AI agents and automation

Complete API reference for Nutrient Python SDK.

Installation

Terminal window
pip install nutrient-sdk

Quick start 

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

ClassDescription
DataExtractionExtracts 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.
DocumentRepresents 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.
LicenseManages licensing for the Nutrient Native SDK. Provides methods to register license keys and trace licensed features in evaluation mode (without registering a key).
QueryEntry 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 a static create_index overload, passing either an open document or an input path and document settings, then call text_search 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.
TelemetryTelemetry 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.
VisionProvides machine learning and computer vision capabilities for document processing. Enables AI-powered document description and content extraction.

Class groups

GroupDescription
editorsDocument editor classes for PDF and Word manipulation
editors.pdf.annotationsPDF annotation types (highlight, text, shape, stamp, and more)
editors.pdf.formfieldsPDF form field types (text, check box, radio, list, signature)
editors.pdf.pagesPDF page access, metadata, and page collections
enumsEnumeration types used across the SDK
exceptionsSDK-specific exception classes raised by operations that can fail
exportersExporters for PDF, image, Markdown, HTML, SVG, Word, spreadsheet, and presentation formats
interfacesInterface definitions implemented by SDK types
requestsrequests classes
resultsresults classes
settingsConfiguration objects controlling SDK behavior
signingDigital signatures, appearance, and timestamp configuration
typesPrimitive value types such as Color, RectF, and vec2f
validationvalidation classes

Statistics

  • Classes: 156
  • Enumerations: 53
  • Value types: 2

Additional resources