Skip to main content
Nutrient Document Web Services API logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API
  • Version: 20261101_00

Tools

Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_ANALYZE_BUILDEstimate the credit cost and required Processor features for legacy Build instructions. This compatibility tool is deprecated.

Input Parameters

array
required
Legacy Build parts passed through without renaming nested fields.
object
Legacy Build output settings passed through without renaming nested fields.
array
Legacy Build actions passed through without renaming nested fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_ANALYZE_BUILD_COSTEstimate the credits and Processor features required by Build API instructions without executing the document job or consuming credits.

Input Parameters

array
required
Build parts using remote files, HTML, new pages, or Document Engine documents. Use snake_case fields such as page_count; they are converted for Nutrient. Add content_type to non-PDF file parts for accurate conversion costs.
string
Output object whose type is pdf, pdfa, pdfua, image, json-content, docx, xlsx, pptx, html, or markdown. Add format-specific fields such as conformance for PDF/A or format/pages/width/height/dpi for images.
array
Ordered action objects whose type is applyInstantJson, applyRedactions, applyXfdf, createRedactions, flatten, ocr, rotate, or watermark. Include the fields required by that action type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_BUILD_DOCUMENTSynchronously create one document from remote files, remote HTML, new pages, and composable safe actions, returning its filename, media type, and Base64 content up to 4 MB. Use this for multi-part or multi-step workflows; applied redaction and JSON-content output are not supported. This consumes Processor credits; run ANALYZE_BUILD_COST and check GET_PROCESSOR_USAGE first. Free-tier output may be watermarked.

Input Parameters

array
required
Build parts using remote files, HTML, new pages, or Document Engine documents. Use snake_case fields such as page_count; they are converted for Nutrient.
string
File output object whose type is pdf, pdfa, pdfua, image, docx, xlsx, pptx, html, or markdown. Add format-specific fields such as conformance for PDF/A, format/pages/width/height/dpi for images, or layout for HTML.
array
Ordered action objects whose type is applyInstantJson, applyXfdf, flatten, ocr, rotate, watermark, or createRedactions. Include that action type’s documented fields; applyRedactions and unknown action types are rejected.
string
Fallback filename for the downloaded result. A filename supplied by Nutrient is preferred so its format-specific extension is preserved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_CONVERT_MARKDOWN_TO_PDFConvert CommonMark or GitHub-Flavored Markdown text into a PDF using optional built-in styling, custom CSS, page layout, and syntax highlighting settings. Returns the filename, media type, and Base64 content up to 4 MB. This consumes Processor credits; check GET_PROCESSOR_USAGE first. Free-tier output may be watermarked.

Input Parameters

string
CSS appended after the selected template stylesheet.
object
Optional generated-page size, orientation, and margins.
string
Filename for the downloadable PDF result.
string
required
Markdown source to convert, up to Nutrient’s 5 MB limit.
string ("built-in:default" | "built-in:minimal" | "built-in:corporate" | "built-in:elegant" | "built-in:executive" | "built-in:nordic" | "built-in:nordic-report" | "built-in:technical" | "built-in:elegant-presentation" | "built-in:nordic-executive" | "built-in:nordic-presentation")
Built-in HTML and CSS template. Custom HTML templates require the multipart API variant and are not accepted by this JSON action.
object
Optional Markdown rendering and syntax-highlighting settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_CREATE_JWT_TOKENCreate a Nutrient bearer token with optional operation and origin restrictions and an expiration time. This deprecated compatibility tool returns secret credential material.

Input Parameters

array
Browser origins allowed to use the token. Requests using an origin-restricted token must send a matching Origin header.
integer
Token lifetime in seconds. Nutrient defaults to 3600 (1 hour) and enforces its own maximum server-side.
array
Operations the generated token may access. Omit to allow every operation available to generated JWTs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_CREATE_PDF_FROM_WEB_PAGERender an HTML web page at a public URL, with optional page layout settings, into a PDF. Returns the filename, media type, and Base64 content up to 4 MB. This consumes Processor credits; check GET_PROCESSOR_USAGE first. Free-tier output may be watermarked.

Input Parameters

string
required
Publicly reachable URL of the HTML page to render.
object
Optional layout for the generated PDF pages.
string
Filename for the downloadable PDF result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_GET_ACCOUNT_INFOReturn the connected Nutrient account’s subscription type, status, and estimated remaining credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_GET_PROCESSOR_USAGEReturn the connected account’s Processor subscription status and credit usage counters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_MAKE_PDF_ACCESSIBLEAuto-tag a PDF at a remote URL for PDF/UA screen-reader accessibility and return the result’s filename, media type, and Base64 content up to 4 MB. This consumes Processor credits; check GET_PROCESSOR_USAGE first. Free-tier output may be watermarked.

Input Parameters

string
required
Publicly reachable URL of the source PDF.
string
Filename for the downloadable PDF/UA result.
string
Password for an encrypted source PDF, if required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_OCR_PDFApply optical character recognition to a PDF at a remote URL and return a searchable PDF’s filename, media type, and Base64 content up to 4 MB. This consumes Processor credits; check GET_PROCESSOR_USAGE first. Free-tier output may be watermarked.

Input Parameters

string
required
Publicly reachable URL of the source PDF.
string
Filename for the downloadable searchable PDF.
array
One or more OCR dictionaries from Nutrient’s documented enum. Use a full name such as english or german, an ISO 639-2 code such as eng or deu, or a specialized dictionary such as chi_sim_vert or deu_frak.
boolean
Skip pages that already contain searchable text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_REVOKE_JWT_TOKENImmediately revoke a bearer token created by CREATE_JWT_TOKEN using its ID. Use this when a generated token is no longer needed or may be compromised.

Input Parameters

string
required
ID returned by CREATE_JWT_TOKEN for the token to revoke.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_STAGE_PDF_REDACTIONSFind matching content in a remote PDF and return a review PDF’s filename, media type, and Base64 content up to 4 MB with unapplied redaction marks. This action cannot permanently apply redactions. It consumes Processor credits; check GET_PROCESSOR_USAGE first. Free-tier output may be watermarked.

Input Parameters

string
required
Publicly reachable URL of the source PDF.
string
required
Text, regular expression, word-based phrase, or documented preset name required by the selected strategy.
string
Filename for the downloadable staged-redaction PDF.
string
Password for an encrypted source PDF, if required.
string ("text" | "regex" | "preset" | "word_based")
required
Rule type used to locate content for redaction.
object
Optional page range, case matching, and annotation matching settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTRIENT_DOCUMENT_WEB_SERVICES_API_WATERMARK_PDFAdd a positioned text or image watermark to every page of a PDF at a public URL and return the copy’s filename, media type, and Base64 content up to 4 MB. This consumes Processor credits; check GET_PROCESSOR_USAGE first. Free-tier output may also include Nutrient’s watermark.

Input Parameters

string
required
Publicly reachable URL of the source PDF.
object
Optional font settings for the watermark text.
string
Text to place on every page.
object
Remote image to place on every page.
string
Watermark width in points, percent, or explicit units.
string
Watermark height in points, percent, or explicit units.
number
Watermark opacity from 0 (fully transparent) to 1 (fully opaque).
string
Filename for the downloadable watermarked PDF.
number
Counterclockwise rotation in degrees. Nutrient defaults to 0.
string
Offset from the top edge in points, percent, or explicit units.
string
Offset from the left edge in points, percent, or explicit units.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not