Nitro PDF Services (Preview)

The Nitro PDF Services connector provides end-to-end PDF and document processing: converting between formats (PDF, Word, Excel, images, HTML), compressing, merging, splitting, and editing files (rotate, delete pages, protect/unprotect, flatten, redact). They also extract structured data and insights from PDFs - text, tables, metadata, form data, and PII with locations - while supporting secure API access and document property management.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Nitro support
URL https://www.gonitro.com/support
Email prosupport@sfdc.gonitro.com
Connector Metadata
Publisher Nitro PDF
Website https://www.gonitro.com/
Privacy policy https://www.gonitro.com/legal/privacy-policy
Categories Productivity; IT operations

Nitro PDF Services Connector

Overview

The Nitro PDF Services connector exposes the Nitro PDF Services API — a comprehensive set of PDF processing capabilities that let you convert, edit, protect, extract data from, and transform PDF documents programmatically inside your flows.

Publisher: Nitro Software Version: 1.1 Released: 2026-07-22

What's new in this version

This version adds the following capabilities on top of the previously certified release. No operations from the previous release have been removed, and existing flows continue to work without changes.

  • Picker-native chaining. Every action that returns a file now exposes File Name and File Content tokens in the dynamic-content picker. Drop them into the next action's File Name and File Content inputs to chain multi-step flows (for example, Optimize PDF → PDF to Word → Watermark PDF) without expressions or manual filename entry.
  • PDF to PowerPoint. Convert a PDF into an editable PowerPoint (.pptx) presentation.
  • PDF to PDF/A. Convert a standard PDF into the ISO-standardized PDF/A archival format. Supports 8 conformance levels (1b, 1a, 2b, 2u, 2a, 3b, 3u, 3a) so documents can be preserved for long-term retention without external font or colour-profile dependencies.
  • Optimize PDF. Reduce PDF file size using one of five named profiles: Web (linearized for fast web delivery, screen-resolution downsampling), Print (preserves print-resolution images), Archive (reduced size prepared for conversion to PDF/A), Minimal File Size (aggressive downsampling for the smallest possible output), and Mixed Raster Content (MRC compression that separates text and background layers, best for scanned pages).
  • Watermark PDF. Overlay an image watermark onto specific pages of a PDF. Accepts PNG, JPEG, TIFF, GIF, or SVG as the watermark image.
  • OCR PDF. Apply Optical Character Recognition to a scanned or image-based PDF, producing a searchable and selectable text layer without altering the document's visual appearance. Supports English, German, French, Spanish, Italian, Finnish, Swedish, Danish, Norwegian, Dutch, Portuguese, and Brazilian Portuguese (one language per request).
  • Fill PDF Form. Populate a fillable PDF (AcroForm) with field values supplied as JSON, CSV, XFDF, or FDF and receive a flattened, filled PDF back.
  • Create Fillable Forms. Given a PDF and a description of the form fields to create, write those fields into the document as a real AcroForm and return a fillable PDF.
  • Smart Detect Form Fields. Analyze a PDF and return the locations where fillable form fields should be placed. The output can be piped directly into Create Fillable Forms to turn a non-form document into a fillable form.
  • Extract Invoice Data. Extract structured invoice and receipt data — vendor name and address, dates, invoice number, currency, subtotal, tax, total, and line items — from a PDF. Scanned invoices are handled automatically via built-in OCR.
  • Improved input experience. Common operation parameters are now dropdowns instead of freeform text, and file inputs use consistent labels (Word File, Excel File, and so on) across every action.

Prerequisites

To use the Nitro PDF Services connector, you need:

  • Access to the Nitro PDF Services API. This capability is currently available through an early-access program — request access at https://www.gonitro.com/contact-sales/early-access-automate.
  • A subscription that includes premium connectors in your target host (Microsoft Power Automate, Microsoft Power Apps, Azure Logic Apps, or Microsoft Copilot Studio).

Authentication

The Nitro PDF Services API uses machine-to-machine OAuth 2.0 with the Client Credentials grant.

How it works

  • Sign in to the Nitro admin portal at https://admin.gonitro.com using your global admin credentials.
  • Create an API application to obtain a Client ID and a Client Secret.
  • The connector exchanges those credentials for a short-lived Bearer access token at https://api.gonitro.dev/oauth/token and uses that token to authorize downstream API calls.
  • Access tokens are valid for 24 hours; the connector caches and refreshes them automatically.

Detailed credential setup steps are available in the Nitro authentication documentation.

Creating a connection

When adding the connector to a flow or app:

  1. Select Add a new connection.
  2. Enter the Nitro Client ID and Nitro Client Secret issued in the Nitro admin portal.
  3. Save the connection. The connector obtains and refreshes access tokens automatically.

No user-interactive sign-in is required. The connection is designed for server-to-server scenarios.

API host and base path

https://api.gonitro.dev

Supported operations

Convert

Convert between PDF and other document formats.

  • Word to PDF, PDF to Word — convert to and from .doc, .docx, .docm, .dotx, .dotm.
  • Excel to PDF, PDF to Excel — convert to and from .xls, .xlsx, .xlsm, .xltx, .xltm.
  • PowerPoint to PDF, PDF to PowerPoint — convert to and from .ppt, .pptx.
  • Image to PDF, PDF to Image — supported image formats: JPEG, PNG, GIF, TIFF, and SVG (input); JPEG and PNG (output).
  • HTML to PDF — also accepts XML, CSV, EPS, and RTF as source formats.
  • PDF to PDF/A — convert to any of 8 PDF/A conformance levels for long-term archival.

Conversions return a binary file by default. To receive a signed storage URL instead, set the Accept (Output format) advanced input to application/json.

Transform

Modify or restructure an existing PDF.

  • Optimize PDF — reduce file size using a named profile (Web, Print, Archive, Minimal File Size, or Mixed Raster Content).
  • Compress PDF — reduce file size with no parameters required. Internally, Compress is a special case of Optimize that always applies the most aggressive smallest-file-size profile; use it when you simply want a smaller PDF for sharing or uploading.
  • Flatten PDF — turn interactive or layered elements — form fields, annotations, digital signatures, layers, and transparencies — into static, non-editable content. The operation is irreversible.
  • Rotate PDF Pages — rotate individual pages by index. Supported angles are 90, 180, and 270 degrees.
  • Delete PDF Pages — remove pages by index.
  • Split PDF Document — split a multi-page PDF into multiple PDFs using custom page ranges.
  • Merge PDF Documents — combine multiple PDFs into a single document, placing the pages of each source file in order. An optional table of contents can be generated from the source filenames.
  • Watermark PDF — overlay an image watermark on specified pages.
  • Redact PDF Pages — add redaction rectangles to hide sensitive content.
  • Set PDF Properties — update PDF metadata fields (title, author, subject, keywords, creator, producer).
  • Password Protect PDF — apply a password and control what users can do with the file via optional permissions (print, modify, copy, annotate, form, assemble, print-hq).
  • Unprotect PDF — remove passwords and their associated permission restrictions.
  • OCR PDF — apply OCR to a scanned or image-based PDF and return a version with a searchable, selectable text layer.

Transformations return a binary file by default; the same Accept-header switch to application/json applies.

Extract

Retrieve structured or unstructured data from a PDF. Extractions always return JSON.

  • Extract PDF Form Data — read the field values of a filled AcroForm and return each field's name, value, type, and position.
  • Smart Detect Form Fields — detect where fillable form fields should be placed on a document that does not yet have a form. Output can be piped directly into Create Fillable Forms.
  • Extract PDF Table Data — detect and return tabular content from a PDF, including cells, headers, footers, and per-cell confidence scores.
  • Extract Text from PDF — extract the full-document text or, optionally, only specific pages via the pageIndices parameter.
  • Extract PII Location from PDF — locate specific strings in a PDF and return their bounding boxes.
  • Extract PII from PDF — identify Personal Identifiable Information (PII) in a PDF and return each occurrence with its bounding box, type, and confidence score. Supports English and Spanish.
  • Extract Properties from PDF — read PDF metadata fields (title, author, subject, keywords, creator, producer, creation date, modification date, trapped flag).
  • Extract Invoice Data from PDF — extract structured invoice and receipt fields (vendor, address, dates, invoice number, currency, subtotal, tax, total, line items) from a PDF. Scanned documents are handled via built-in OCR.

Fill and create forms

  • Fill PDF Form — populate a fillable PDF using a JSON, CSV, XFDF, or FDF payload of field values and receive the filled PDF back.
  • Create Fillable Forms — take a PDF plus a description of the form fields to create and return the same PDF with those fields written as a real AcroForm.

Chaining actions in a flow

Every action that returns a file exposes three response tokens in the dynamic-content picker: File Name, File Content Type, and File Content. To pass the output of one Nitro action into the file input of a subsequent Nitro action, drop File Name into the next action's File Name input and File Content into its File Content input. No expressions or manual filename typing are required.

By default, actions run in synchronous binary mode. For advanced scenarios, an individual action can be switched to:

  • Storage URL mode — set the Accept (Output format) advanced input to application/json. The response includes a signed URL to the processed file instead of a file body. The signed URL is valid for approximately 15 minutes.
  • Asynchronous mode — set the Prefer header to respond-async. The response includes a Job ID that can be polled separately.

Errors and throttling

The Nitro PDF Services API can return the following HTTP status codes:

  • 400 — Bad Request. The request payload or parameters were invalid (for example, a password-protected input PDF, a page index out of bounds, or an unsupported watermark image format).
  • 401 — Unauthorized. The access token was missing, expired, or malformed.
  • 403 — Forbidden. The caller does not have permission for the requested operation.
  • 404 — Not Found. The requested resource does not exist.
  • 405 — Method Not Allowed. The HTTP method is not permitted for the endpoint.
  • 406 — Not Acceptable. The Accept header requested an unsupported response format.
  • 408 — Request Timeout. The request took too long, typically due to network issues or an oversized payload.
  • 410 — Gone. A referenced file is no longer available (files are removed from temporary storage after their retention window).
  • 413 — Content Too Large. The uploaded file exceeded the size limit.
  • 415 — Unsupported Media Type. The file format is not supported for the requested operation.
  • 422 — Unprocessable Entity. The parameters were structurally valid but could not be processed (for example, invalid delivery instructions or an unsupported operation for the endpoint group).
  • 429 — Too Many Requests. The rate limit was exceeded. The response includes a retry_after value (in seconds) indicating how long to wait before retrying.
  • 500 — Internal Server Error. An unexpected server-side error occurred.

Platform limits

  • File size. Up to 100 MB per request. Applies to both single-file and multi-file operations.
  • Page count. Up to 500 pages per individual document. Multi-file operations may exceed 500 pages combined, provided no single document exceeds the limit.
  • File retention. Input and output files stored on Nitro's temporary storage are removed approximately 15 minutes after operation completion. Downstream signed URLs also expire within this window.
  • Rate limiting. The API enforces per-account rate limits. When a limit is hit, the API returns HTTP 429 with a retry_after value in the response.

Known issues and limitations

  • Files must be under 100 MB. Larger requests return 413 — Content Too Large. Split large PDFs before processing.
  • Temporary files expire in ~15 minutes. Persist processed files to a durable location (for example, OneDrive, SharePoint, or an S3 bucket) within that window if you need long-term retention.
  • Storage-URL and asynchronous response tokens are always visible in the picker. When an action runs in the default synchronous binary mode, the unused Result, Job ID, Job Status, and Job Progress tokens resolve to null and can be ignored.
  • OCR processes one language per request. For mixed-language documents, choose the dominant language or split the document by language.

Notes

  • Conversions, transformations, OCR, and form operations return a binary file by default and can be switched to storage-URL or asynchronous mode via advanced inputs.
  • Extraction operations always return JSON.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Nitro Client ID securestring Your Nitro application Client ID True
Nitro Client Secret securestring Your Nitro application Client Secret True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Compress PDF Document

Compress a PDF to reduce its file size. Applies a fixed smallest-file-size profile (a special case of Optimize); for finer control over the size/quality trade-off, use Optimize and its profile.
Create Fillable Forms

Create a fillable AcroForm in a PDF by automatically adding form fields where they belong. The PDF with the new fillable form is returned.
Delete PDF Pages

Remove one or more specified pages from a PDF document.
Excel to PDF

Convert an Excel workbook into a PDF document while preserving layout and formatting.
Extract all Text from PDF

Extract all readable text content from a PDF document.
Extract Invoice Data from PDF

Extract structured invoice or receipt data from a PDF document, including line items, totals, dates, and vendor information.
Extract PDF Form Data

Extract form field data from a PDF document, can work with an imaged based PDFs. Returns key value pairs, the label and data from the form.
Extract PDF Table Data

Extract tabular data from a PDF document. Automatically identifies all tables present in the file and returns each table's cells, headers, footers, and confidence scores.
Extract PII from PDF

Detect and extract personally identifiable information (PII) from a PDF document. Returns PII values, PII categories and bounding box locations for that PII. Can be used in conjunction with Redaction block to redact PDFs.
Extract Properties from PDF

Retrieve document metadata and properties such as title, author, creation date, and file details.
Extract searched Text from PDF

Identify the locations of searchable text within a PDF document, using literal text or regular expression queries. Returns bounding box position data for each match, grouped per query in request order.
Fill PDF Form

Fill a PDF AcroForm from a data file. Provide the PDF form template and a data file (CSV, JSON, XFDF, or FDF) mapping form field names to values. The filled PDF is returned.
Flatten PDF Document

Flatten a PDF by converting form fields and annotations into static, non-editable content.
HTML to PDF

Convert HTML content or a web page into a PDF document.
Image to PDF

Convert one or more image files into a single PDF document.
Merge PDF Documents

Combine multiple PDF documents into a single PDF file.
OCR PDF Document

Apply OCR to a scanned or image based PDF to make all text searchable.
Optimize PDF Document

Optimize a PDF for a specific output target. Profiles: web (linearise + downsample for fast web/email delivery), print (preserve print-resolution images for high-quality printing), archive (reduce size and prepare for PDF/A conversion), minimal-file-size (aggressively downsample and strip redundant data for the smallest file), mixed-raster-content (MRC compression separating text and background layers, best for scanned documents).
Password Protect PDF Document

Add password protection to a PDF document to restrict access or editing.
PDF to Excel

Convert a PDF document into an editable Excel file.
PDF to Image

Convert each page of a PDF document into image files.
PDF to PDFA

Convert a PDF document into PDF/A archival format for long-term preservation. PDF/A is an ISO-standardized PDF subset that embeds all fonts, colour profiles, and metadata required to render the document identically in the future without external dependencies.
PDF to PowerPoint

Convert a PDF document into an editable PowerPoint file.
PDF to Word

Convert a PDF document into an editable Word file.
PowerPoint to PDF

Convert a PowerPoint presentation into a PDF document.
Redact PDF Pages

Permanently remove or obscure specified content within selected PDF pages.
Rotate PDF Document

Rotate one or more pages within a PDF document to the desired orientation.
Set PDF Properties

Update document metadata such as title, author, subject, or keywords.
Smart Detect Form Fields

Detect where fillable form fields should go in a PDF document. Returns the detected form-field bounding boxes.
Split PDF Document

Split a PDF document into multiple files based on page ranges or individual pages.
Unprotect PDF Document

Remove password protection from a PDF document when valid credentials are provided.
Watermark PDF Document

Overlay a watermark image onto one or more pages of a PDF document.
Word to PDF

Convert a Word document into a PDF file while preserving formatting.

Compress PDF Document

Operation ID:
CompressPDFDocument

Compress a PDF to reduce its file size. Applies a fixed smallest-file-size profile (a special case of Optimize); for finer control over the size/quality trade-off, use Optimize and its profile.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Create Fillable Forms

Operation ID:
CreateFillableForms

Create a fillable AcroForm in a PDF by automatically adding form fields where they belong. The PDF with the new fillable form is returned.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to turn into a fillable form.
Form Fields (JSON)
 params True string

JSON describing the form fields to create — the output of the Smart Detect Form Fields action. Shape: {"formFields":[{"pageIndex":0,"fieldType":"TextBox"|"CheckBox","name":"FirstName","boundingBox":[x,y,width,height],"value":"optional"}]}.

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Delete PDF Pages

Operation ID:
DeletePDFPages

Remove one or more specified pages from a PDF document.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process
Delete Pages
 params True string

Format {"pageIndices":[0,2]}

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Excel to PDF

Operation ID:
ExcelToPDF

Convert an Excel workbook into a PDF document while preserving layout and formatting.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
Excel File
 file True file

The Excel file to convert

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Extract all Text from PDF

Operation ID:
ExtractTextFromPDF

Extract all readable text content from a PDF document.

Parameters

Name Key Required Type Description
PDF File
 file True file

The PDF file to process
Extraction Parameters
 params string

Optional JSON object. Fields: pageIndices (int array, e.g. [0,2]; omit for full document) and readingOrder (boolean, default false; reorders text for visual reading flow).

Returns

Name Path Type Description
result
 result string

JSON Result

Extract Invoice Data from PDF

Operation ID:
ExtractInvoiceDataFromPDF

Extract structured invoice or receipt data from a PDF document, including line items, totals, dates, and vendor information.

Parameters

Name Key Required Type Description
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
expenseDocuments
 result.expenseDocuments array of object

expenseDocuments
summaryFields
 result.expenseDocuments.summaryFields array of object

summaryFields
type
 result.expenseDocuments.summaryFields.type string

type
value
 result.expenseDocuments.summaryFields.value string

value
confidence
 result.expenseDocuments.summaryFields.confidence float

confidence
pageNumber
 result.expenseDocuments.summaryFields.pageNumber integer

pageNumber
currency
 result.expenseDocuments.summaryFields.currency string

currency
summaryGroups
 result.expenseDocuments.summaryGroups array of object

summaryGroups
groupType
 result.expenseDocuments.summaryGroups.groupType string

groupType
fields
 result.expenseDocuments.summaryGroups.fields array of object

fields
type
 result.expenseDocuments.summaryGroups.fields.type string

type
value
 result.expenseDocuments.summaryGroups.fields.value string

value
confidence
 result.expenseDocuments.summaryGroups.fields.confidence float

confidence
pageNumber
 result.expenseDocuments.summaryGroups.fields.pageNumber integer

pageNumber
lineItemGroups
 result.expenseDocuments.lineItemGroups array of object

lineItemGroups
lineItems
 result.expenseDocuments.lineItemGroups.lineItems array of object

lineItems
fields
 result.expenseDocuments.lineItemGroups.lineItems.fields array of object

fields
type
 result.expenseDocuments.lineItemGroups.lineItems.fields.type string

type
value
 result.expenseDocuments.lineItemGroups.lineItems.fields.value string

value
confidence
 result.expenseDocuments.lineItemGroups.lineItems.fields.confidence float

confidence
pageNumber
 result.expenseDocuments.lineItemGroups.lineItems.fields.pageNumber integer

pageNumber

Extract PDF Form Data

Operation ID:
ExtractPDFFormData

Extract form field data from a PDF document, can work with an imaged based PDFs. Returns key value pairs, the label and data from the form.

Parameters

Name Key Required Type Description
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
fields
 result.fields array of object

fields
fieldName
 result.fields.name string

Form field name
fieldValue
 result.fields.value string

Form field value
fieldConfidence
 result.fields.confidence float

Form field confidence
averageConfidence
 result.averageConfidence float

averageConfidence

Extract PDF Table Data

Operation ID:
ExtractPDFTableData

Extract tabular data from a PDF document. Automatically identifies all tables present in the file and returns each table's cells, headers, footers, and confidence scores.

Parameters

Name Key Required Type Description
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
formFields
 result.formFields array of object

Detected form fields
pageIndex
 result.formFields.pageIndex integer

Zero-based page index the field is on
fieldType
 result.formFields.fieldType string

TextBox or CheckBox
name
 result.formFields.name string

Detected form field name
boundingBox
 result.formFields.boundingBox array of float

Bounding box [x, y, width, height] in PDF points
value
 result.formFields.value string

Initial field value

Extract PII from PDF

Operation ID:
ExtractPIIFromPDF

Detect and extract personally identifiable information (PII) from a PDF document. Returns PII values, PII categories and bounding box locations for that PII. Can be used in conjunction with Redaction block to redact PDFs.

Parameters

Name Key Required Type Description
Document Language
 language True string

Language of the PDF text for PII detection.
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
PIIBoxes
 result.PIIBoxes array of object

PIIBoxes
ID
 result.PIIBoxes.ID string

ID
text
 result.PIIBoxes.text string

text
textPiece
 result.PIIBoxes.textPiece string

textPiece
pageIndex
 result.PIIBoxes.pageIndex integer

pageIndex
boundingBox
 result.PIIBoxes.boundingBox array of number

boundingBox
PIIType
 result.PIIBoxes.PIIType string

PIIType
confidence
 result.PIIBoxes.confidence float

confidence

Extract Properties from PDF

Operation ID:
ExtractPropertiesFromPDF

Retrieve document metadata and properties such as title, author, creation date, and file details.

Parameters

Name Key Required Type Description
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
title
 result.title string

title
author
 result.author string

author
subject
 result.subject string

subject
keywords
 result.keywords string

keywords
creator
 result.creator string

creator
producer
 result.producer string

producer
creationDate
 result.creationDate string

creationDate
modDate
 result.modDate string

modDate
trapped
 result.trapped string

trapped

Extract searched Text from PDF

Operation ID:
ExtractPIILocationFromPDF

Identify the locations of searchable text within a PDF document, using literal text or regular expression queries. Returns bounding box position data for each match, grouped per query in request order.

Parameters

Name Key Required Type Description
Queries to Search
 params True string

Format {"queries": [{"text": "Name"}, {"text": "tax id: [0-9]+", "isRegex": true, "regexFlags": ["ignore-case"]}]}. Each query is literal text by default; set isRegex to true to match it as a regular expression. Optional regexFlags (regex queries only): ignore-case, multiline, dot-all.
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
textBoxes
 result.textBoxes array of object

textBoxes
text
 result.textBoxes.query.text string

text
isRegex
 result.textBoxes.query.isRegex boolean

isRegex
regexFlags
 result.textBoxes.query.regexFlags array of string

regexFlags
matches
 result.textBoxes.matches array of object

matches
matchedText
 result.textBoxes.matches.matchedText string

matchedText
boxes
 result.textBoxes.matches.boxes array of object

boxes
pageIndex
 result.textBoxes.matches.boxes.pageIndex integer

pageIndex
boundingBox
 result.textBoxes.matches.boxes.boundingBox array of number

boundingBox [x, y, width, height]
textPiece
 result.textBoxes.matches.boxes.textPiece string

textPiece
groups
 result.textBoxes.matches.groups array of object

groups
index
 result.textBoxes.matches.groups.index integer

index
text
 result.textBoxes.matches.groups.text string

text
boxes
 result.textBoxes.matches.groups.boxes array of object

boxes
pageIndex
 result.textBoxes.matches.groups.boxes.pageIndex integer

pageIndex
boundingBox
 result.textBoxes.matches.groups.boxes.boundingBox array of number

boundingBox [x, y, width, height]
textPiece
 result.textBoxes.matches.groups.boxes.textPiece string

textPiece

Fill PDF Form

Operation ID:
FillPDFForm

Fill a PDF AcroForm from a data file. Provide the PDF form template and a data file (CSV, JSON, XFDF, or FDF) mapping form field names to values. The filled PDF is returned.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF Form Template
 file True file

PDF AcroForm template to fill. Must be submitted first.
Form Data File (CSV, JSON, XFDF, or FDF)
 dataFile file

Data file mapping form field names to values. Accepts CSV, JSON, XFDF, or FDF. JSON format: a list of field/value objects, e.g. [{"field":"name","value":"x"},{"field":"address","value":"y"}]. Each item needs a "field" (the form field name) and a "value" (string, number, boolean, or null). XFDF and FDF are standard Adobe form-data files exported from a PDF tool. Optional: instead of a file you can supply the values inline via the Options (JSON) field's "fields" key.
Options (JSON)
 params string

Optional JSON options. Keys: "strict" (boolean) — when true, unknown or missing required fields fail the request (422); when false (default) they are ignored. "fields" — inline field values as an alternative to uploading a data file, e.g. {"fields":[{"field":"name","value":"x"},{"field":"address","value":"y"}]}. Provide either a Form Data File or inline "fields".

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Flatten PDF Document

Operation ID:
FlattenPDFDocument

Flatten a PDF by converting form fields and annotations into static, non-editable content.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

HTML to PDF

Operation ID:
HTMLToPDF

Convert HTML content or a web page into a PDF document.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
HTML File
 file True file

The HTML file to convert

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Image to PDF

Operation ID:
ImageToPDF

Convert one or more image files into a single PDF document.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
Image File
 file True file

The Image file to convert

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Merge PDF Documents

Operation ID:
MergePDFDocuments

Combine multiple PDF documents into a single PDF file.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
File 1
 file1 True file

PDF file content to merge (1)
File 2
 file2 True file

PDF file content to merge (2)
File 3
 file3 file

PDF file content to merge (3)
File 4
 file4 file

PDF file content to merge (4)
File 5
 file5 file

PDF file content to merge (5)
File 6
 file6 file

PDF file content to merge (6)
File 7
 file7 file

PDF file content to merge (7)
File 8
 file8 file

PDF file content to merge (8)
Options (JSON)
 params string

Optional JSON options. Key: "tableOfContents" — controls the Table of Contents page prepended to the merged PDF, e.g. {"tableOfContents":{"enabled":true}}. "enabled" defaults to true; set it to false to merge without a Table of Contents page.

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

OCR PDF Document

Operation ID:
OCRPDFDocument

Apply OCR to a scanned or image based PDF to make all text searchable.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to apply OCR to
OCR Parameters
 params string

Optional JSON OCR parameters. language: document language for recognition ("english", "german", "french", "spanish", "italian", "finnish", "swedish", "danish", "norwegian", "dutch", "portuguese", "brazilian"; default: "english"). quality: trade-off between speed and accuracy ("low", "medium", "high"; default: "high"). isOutputPDFEditable: when true, recognised text is rendered over the page image making it editable; when false (default), text is placed behind the image preserving visual appearance. compressionLevel: compression applied to the output PDF ("low", "medium", "high"; default: "low"). PDFVersion: PDF specification version for the output file ("pdf14", "pdf15", "pdf16", "pdf17"; default: "pdf17"). pageIndices: zero-based page indices to process ([0,1,...] or omit for all pages).

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Optimize PDF Document

Operation ID:
OptimizePDFDocument

Optimize a PDF for a specific output target. Profiles: web (linearise + downsample for fast web/email delivery), print (preserve print-resolution images for high-quality printing), archive (reduce size and prepare for PDF/A conversion), minimal-file-size (aggressively downsample and strip redundant data for the smallest file), mixed-raster-content (MRC compression separating text and background layers, best for scanned documents).

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
Optimization Profile
 profile True string

Choose based on the target output. web — fast viewing and smaller size. print — preserves print-resolution images. archive — prepares the file for PDF/A conversion. minimal-file-size — aggressive compression. mixed-raster-content — MRC compression, best for scanned pages with mixed text and images.
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Password Protect PDF Document

Operation ID:
PasswordProtectPDFDocument

Add password protection to a PDF document to restrict access or editing.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process
Protection Parameters
 params True string

Format {"ownerPredentials":"owner-secret", "userPassword": "user-secret", "permissions": [ "print", "copy" ] }

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

PDF to Excel

Operation ID:
PDFToExcel

Convert a PDF document into an editable Excel file.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

PDF to Image

Operation ID:
PDFToImage

Convert each page of a PDF document into image files.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
Output Image Format
 to True string

Image format for each converted page.
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

PDF to PDFA

Operation ID:
PDFToPDFA

Convert a PDF document into PDF/A archival format for long-term preservation. PDF/A is an ISO-standardized PDF subset that embeds all fonts, colour profiles, and metadata required to render the document identically in the future without external dependencies.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process
PDF/A Parameters
 params True string

PDF/A conversion parameters as a JSON string. Required: to (must be "pdfa"), conformance (one of: 1b, 1a, 2b, 2u, 2a, 3b, 3u, 3a). Optional: imageQuality (number, 0.01–1.0, default 0.8), copyMetadata (boolean, default true). Note: conformance levels ending in a (1a/2a/3a) require the source PDF to be tagged (logical structure tree); use b or u variants for general-purpose archiving.

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

PDF to PowerPoint

Operation ID:
PDFToPowerPoint

Convert a PDF document into an editable PowerPoint file.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

PDF to Word

Operation ID:
PDFToWord

Convert a PDF document into an editable Word file.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

PowerPoint to PDF

Operation ID:
PowerPointToPDF

Convert a PowerPoint presentation into a PDF document.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PowerPoint File
 file True file

The PowerPoint file to convert

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Redact PDF Pages

Operation ID:
RedactPDFPages

Permanently remove or obscure specified content within selected PDF pages.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
Properties
 params True string

Format {"redactions":[{"pageIndex": 0,"boundingBox":[100,100,200,120]},{"pageIndex": 1,"boundingBox":[50,50,150,70]}]}
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Rotate PDF Document

Operation ID:
RotatePDFDocuments

Rotate one or more pages within a PDF document to the desired orientation.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process
Rotate pages (clockwise degrees)
 params True string

Format {"rotations":[{"page_index": 0,"amount": 90}]}

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Set PDF Properties

Operation ID:
SetPDFProperties

Update document metadata such as title, author, subject, or keywords.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
Properties
 params True string

Format {"title":"My Document Title","author": "John Doe","subject": "An Interesting Subject","keywords": "example, pdf, metadata","creator": "Doe John","producer": "Nitro PDF"}
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Smart Detect Form Fields

Operation ID:
SmartDetectFormFields

Detect where fillable form fields should go in a PDF document. Returns the detected form-field bounding boxes.

Parameters

Name Key Required Type Description
PDF File
 file True file

The PDF file to process

Returns

Name Path Type Description
fields
 result.fields array of object

fields
fieldName
 result.fields.name string

Detected form field name
fieldType
 result.fields.type string

Detected form field type
pageIndex
 result.fields.pageIndex integer

Zero-based page index where the field was detected
boundingBox
 result.fields.boundingBox array of float

Bounding box [x0,y0,x1,y1] in PDF points
fieldConfidence
 result.fields.confidence float

Detection confidence

Split PDF Document

Operation ID:
SplitPDFDocument

Split a PDF document into multiple files based on page ranges or individual pages.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process
Pages
 params True string

Format {"pageIndice":[[0,2],[1,3,4]]}

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Unprotect PDF Document

Operation ID:
UnprotectPDFDocument

Remove password protection from a PDF document when valid credentials are provided.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to process
Unprotection parameters
 params True string

Format {"ownerPassword": "owner-secret","userPassword": "user-secret"}

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Watermark PDF Document

Operation ID:
WatermarkPDFDocument

Overlay a watermark image onto one or more pages of a PDF document.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
PDF File
 file True file

The PDF file to watermark
Watermark Image
 watermarkFile True file

Watermark image to overlay onto the PDF (supported formats: PNG, JPEG, TIFF, GIF, SVG)
Watermark Parameters
 params True string

JSON watermark parameters. Required: boundingBox ([x0,y0,x1,y1] in PDF points, e.g. [210,10,290,60]) — omit only if both fitToPageWidth and fitToPageHeight are true. Optional: opacity (0.0–1.0, default 1.0), rotation (degrees, default 0.0), pageIndices ([0,1,...] or omit for all pages), contentDepth ("above_existing" or "below_existing", default "below_existing"), fitToPageWidth (bool), fitToPageHeight (bool), centerOnPage (bool), rotateWithPage (bool), flip ("horizontal", "vertical", or "both").

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Word to PDF

Operation ID:
WordToPDF

Convert a Word document into a PDF file while preserving formatting.

Parameters

Name Key Required Type Description
Accept (Output format)
 Accept string

e.g. application/json
Word File
 file True file

The Word file to convert

Returns

Name Path Type Description
File Name
 fileName string

Filename of the result (bytes mode only — populated when Accept: application/octet-stream). Drop this into the next chained Nitro action's File Name input.
File Content Type
 fileContentType string

MIME content type of the file (bytes mode only — e.g. application/pdf).
File Content
 fileContent byte

Base64-encoded file bytes (bytes mode only). Drop this into the next chained Nitro action's File Content input — Power Automate decodes the base64 when forwarding to a type: file slot.
file
 result.file FileLinkResponse

File reference data
Job ID
 jobID string

Populated in async mode (Prefer: respond-async).
Job Status
 status string

Job status (async mode).
Job Progress
 progress number

Job progress 0.0–1.0 (async mode).

Definitions

FileLinkResponse

File reference data

Name Path Type Description
URL
 URL string

URL
fileSizeBytes
 metadata.fileSizeBytes integer

fileSizeBytes
pageCount
 metadata.pageCount integer

pageCount