> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Nutrient Document Web Services API

> Process, convert, OCR, redact, sign, and analyze documents with Nutrient Document Web Services.

![Nutrient Document Web Services API logo](https://mintcdn.com/composio-preview/9YPuzjEU4UlMnwGq/images/toolkits/nutrient_document_web_services_api.svg?fit=max\&auto=format\&n=9YPuzjEU4UlMnwGq\&q=85\&s=cd36c6f67272f8f8566ff2b1447bebf2)

* **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

> [accordion] Analyze Build Request (Deprecated)
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_ANALYZE_BUILD`
>
> Estimate the credit cost and required Processor features for legacy Build instructions. This compatibility tool is deprecated.
>
> #### Input Parameters
>
> **parts** `array` *required*
>
> Legacy Build parts passed through without renaming nested fields.
>
> **output** `object`
>
> Legacy Build output settings passed through without renaming nested fields.
>
> **actions** `array`
>
> Legacy Build actions passed through without renaming nested fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Analyze Build Cost
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_ANALYZE_BUILD_COST`
>
> Estimate the credits and Processor features required by Build API instructions without executing the document job or consuming credits.
>
> #### Input Parameters
>
> **parts** `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.
>
> **output** `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.
>
> **actions** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Build Document
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_BUILD_DOCUMENT`
>
> Synchronously 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
>
> **parts** `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.
>
> **output** `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.
>
> **actions** `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.
>
> **filename** `string`
>
> Fallback filename for the downloaded result. A filename supplied by Nutrient is preferred so its format-specific extension is preserved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Markdown to PDF
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_CONVERT_MARKDOWN_TO_PDF`
>
> Convert 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
>
> **css** `string`
>
> CSS appended after the selected template stylesheet.
>
> **layout** `object`
>
> Optional generated-page size, orientation, and margins.
>
> **filename** `string`
>
> Filename for the downloadable PDF result.
>
> **markdown** `string` *required*
>
> Markdown source to convert, up to Nutrient's 5 MB limit.
>
> **template** `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.
>
> **markdown\_options** `object`
>
> Optional Markdown rendering and syntax-highlighting settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create JWT Token
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_CREATE_JWT_TOKEN`
>
> Create a Nutrient bearer token with optional operation and origin restrictions and an expiration time. This deprecated compatibility tool returns secret credential material.
>
> #### Input Parameters
>
> **allowed\_origins** `array`
>
> Browser origins allowed to use the token. Requests using an origin-restricted token must send a matching Origin header.
>
> **expiration\_time** `integer`
>
> Token lifetime in seconds. Nutrient defaults to 3600 (1 hour) and enforces its own maximum server-side.
>
> **allowed\_operations** `array`
>
> Operations the generated token may access. Omit to allow every operation available to generated JWTs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create PDF from Web Page
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_CREATE_PDF_FROM_WEB_PAGE`
>
> Render 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
>
> **url** `string` *required*
>
> Publicly reachable URL of the HTML page to render.
>
> **layout** `object`
>
> Optional layout for the generated PDF pages.
>
> **filename** `string`
>
> Filename for the downloadable PDF result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Information
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_GET_ACCOUNT_INFO`
>
> Return the connected Nutrient account's subscription type, status, and estimated remaining credits.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Processor Usage
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_GET_PROCESSOR_USAGE`
>
> Return the connected account's Processor subscription status and credit usage counters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Make PDF Accessible
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_MAKE_PDF_ACCESSIBLE`
>
> Auto-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
>
> **url** `string` *required*
>
> Publicly reachable URL of the source PDF.
>
> **filename** `string`
>
> Filename for the downloadable PDF/UA result.
>
> **password** `string`
>
> Password for an encrypted source PDF, if required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] OCR PDF
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_OCR_PDF`
>
> Apply 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
>
> **url** `string` *required*
>
> Publicly reachable URL of the source PDF.
>
> **filename** `string`
>
> Filename for the downloadable searchable PDF.
>
> **languages** `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.
>
> **skip\_ocr\_for\_searchable\_documents** `boolean`
>
> Skip pages that already contain searchable text.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Revoke JWT Token
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_REVOKE_JWT_TOKEN`
>
> Immediately 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
>
> **token\_id** `string` *required*
>
> ID returned by CREATE\_JWT\_TOKEN for the token to revoke.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stage PDF Redactions
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_STAGE_PDF_REDACTIONS`
>
> Find 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
>
> **url** `string` *required*
>
> Publicly reachable URL of the source PDF.
>
> **content** `string` *required*
>
> Text, regular expression, word-based phrase, or documented preset name required by the selected strategy.
>
> **filename** `string`
>
> Filename for the downloadable staged-redaction PDF.
>
> **password** `string`
>
> Password for an encrypted source PDF, if required.
>
> **strategy** `string ("text" | "regex" | "preset" | "word_based")` *required*
>
> Rule type used to locate content for redaction.
>
> **strategy\_options** `object`
>
> Optional page range, case matching, and annotation matching settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Watermark PDF
>
> **Slug:** `NUTRIENT_DOCUMENT_WEB_SERVICES_API_WATERMARK_PDF`
>
> Add 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
>
> **url** `string` *required*
>
> Publicly reachable URL of the source PDF.
>
> **font** `object`
>
> Optional font settings for the watermark text.
>
> **text** `string`
>
> Text to place on every page.
>
> **image** `object`
>
> Remote image to place on every page.
>
> **width** `string`
>
> Watermark width in points, percent, or explicit units.
>
> **height** `string`
>
> Watermark height in points, percent, or explicit units.
>
> **opacity** `number`
>
> Watermark opacity from 0 (fully transparent) to 1 (fully opaque).
>
> **filename** `string`
>
> Filename for the downloadable watermarked PDF.
>
> **rotation** `number`
>
> Counterclockwise rotation in degrees. Nutrient defaults to 0.
>
> **vertical\_offset** `string`
>
> Offset from the top edge in points, percent, or explicit units.
>
> **horizontal\_offset** `string`
>
> Offset from the left edge in points, percent, or explicit units.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
