Share via

PDF Tools (Preview)

Leverage ConvertAPI’s high-performance PDF toolkit and document conversion features. Merge, split, compress, protect, redact, or rotate your PDF files, and convert them into editable Word, PowerPoint, or Excel documents using our fast and secure service. You can also extract text and tables from both textual and scanned PDFs, making it easy to generate CSV or XLSX outputs. Get your token at: https://www.convertapi.com. For questions or assistance, contact us at support@convertapi.com.

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 ConvertAPI Support
URL https://www.convertapi.com/support
Email support@convertapi.com
Connector Metadata
Publisher ConvertAPI
Website https://www.convertapi.com
Privacy policy https://www.convertapi.com/privacy-policy
Categories Content and Files;Productivity

ConvertAPI Certified Connector for PowerAutomate

ConvertAPI is a powerful file conversion and manipulation service supporting over 200 document, ebook, archive, image, spreadsheet, and presentation formats. This certified connector for PowerAutomate integrates ConvertAPI's robust capabilities directly into your workflows, enabling you to convert files, compress documents, and apply various PDF manipulations with ease.

The apiDefinition.swagger.json and apiProperties.json files can be found here: https://github.com/microsoft/PowerPlatformConnectors/tree/dev/certified-connectors/ConvertAPI

Publisher

ConvertAPI

Prerequisites

Before you begin, ensure you have:

Supported Operations

The connector currently supports the following operations:

Conversion Operations

  • Convert PDF to DOCX
  • Convert PDF to PDF/A
  • Convert PDF to PNG
  • Convert PDF to PPTX
  • Convert PDF to CSV
  • Convert PDF to XLSX
  • Convert PDF to JPG

Manipulation Operations

  • Extract text from PDF
  • Compress a PDF file
  • Remove pages from PDF
  • Extract images from PDF
  • Flatten PDF
  • Merge multiple PDFs
  • Add OCR layer to PDF
  • Protect a PDF
  • Redact PDF
  • Rotate PDF pages
  • Split PDF
  • Remove PDF protection
  • Add watermark to PDF

Document Conversion & Manipulation

Easily convert one input file to another output format or apply advanced PDF operations — such as compressing, merging, rotating, watermarking, and protecting—directly within your PowerAutomate workflows.

Obtaining Credentials

To start using the connector, follow these steps:

  1. Sign up for a free ConvertAPI account.
  2. Navigate to Authentication → Secret Key.
  3. Your Secret Key will be displayed.
  4. Copy your Secret Key and paste it when setting up the connector.

API Documentation

For complete details on how to use the ConvertAPI, please refer to the ConvertAPI Documentation and ConvertAPI Developer Hub.

Integrate this connector into your PowerAutomate environment to streamline file conversions and document manipulations, boosting productivity and workflow efficiency.

Known Issues and Limitations

Currently our integration is limited to the PDF tools listed above. To use our converter's that are not listed here, please use an HTTP call from PowerAutomate to our API.

The PDF Merge operation currently allows merging up to 5 files only.

Deployment instructions

Please use these instructions to deploy this connector as custom connector in Microsoft Power Automate and Power Apps.

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
Token securestring The Token for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add OCR layer to PDF

Add an OCR-based text layer to a scanned or image-based PDF. Specify languages, page ranges, and output type (PDF or TXT).
Add text watermark to PDF

Overlay a text watermark or stamp onto PDF pages. Configure font, rotation, color, alignment, and optional linking. Works under or over page content.
Compress a PDF file

Reduce PDF file size by adjusting image quality, resolution, removing duplicate resources, or applying various compression presets.
Convert PDF to CSV

Extract tables from textual or scanned PDF documents to CSV format. Optionally apply OCR to handle scanned pages, define a delimiter, and set page ranges.
Convert PDF to DOCX

Transform PDF files into editable Word documents. Optionally apply OCR to scanned PDFs, define page ranges, or preserve layout with text boxes (WYSIWYG).
Convert PDF to JPG

Render each page of a PDF as a JPG image. Control resolution, color space (RGB, CMYK, Gray), image width/height, and page rotation if needed.
Convert PDF to PDFA

Convert PDF to an archival PDF/A format (e.g., PDF/A-1b, PDF/A-2u). Adjust metadata, title, author, keywords, and output intent.
Convert PDF to plain text

Extract text from a PDF into a TXT file. Optionally enable OCR, remove headers/footers, ignore tables, or specify page ranges.
Convert PDF to PNG

Render PDF pages to PNG images. Control crop boxes, resolution, page ranges, and password protection.
Convert PDF to PPTX

Transform PDF pages into PowerPoint slides. Apply OCR to scanned PDFs, define page ranges, and handle password protection.
Convert PDF to XLSX

Extract tables and text from PDF to Excel (XLSX). Optionally apply OCR to scanned PDFs, specify page ranges, or combine tables into one sheet.
Extract images from PDF

Retrieve embedded images from each page of a PDF. Configure output image format, resolution, and page ranges. Works with password-protected PDFs as well.
Flatten PDF

Flatten a PDF to make form fields, annotations, and text layers static. Optionally convert editable text to vector paths to protect content from selection or copying.
Merge multiple PDFs

Combine multiple PDF files into a single PDF. Configure page size, orientation, bookmarks, and more. Supports up to five input files in this definition (Files[0]–Files[4]).
Overlay PDF watermark

Use another PDF as a watermark or stamp overlay. Adjust opacity, position, page range, and more. Ideal for adding logos or disclaimers.
Protect a PDF

Add encryption and set permissions on a PDF. Restrict printing, copying, or modifying. Configure owner/user passwords and encryption algorithms (RC4, AES, etc.).
Redact PDF

Permanently remove or hide sensitive data from a PDF. Use AI-based detection or supply custom RedactionData. Optionally specify page ranges.
Remove pages from PDF

Delete specific pages from a PDF document using a page range or comma-separated page list. Also supports password-protected PDFs.
Remove PDF protection

Remove password-based restrictions from a PDF. Enter the user password to remove user-level security or leave empty to remove only owner-level restrictions.
Rotate PDF pages

Rotate selected PDF pages by 90, 180, or 270 degrees. Optionally specify page ranges and handle password protection.
Split PDF

Break a PDF into multiple files using custom ranges, patterns, or text searches. Optionally compress output or merge extracted ranges into one file.

Add OCR layer to PDF

Operation ID:
convertPdfToOcr

Add an OCR-based text layer to a scanned or image-based PDF. Specify languages, page ranges, and output type (PDF or TXT).

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to which you want to add a textual layer.
File Name
 FileName string

Set the output file name (optional)
OCR Language
 OcrLanguage string

Set the OCR language. Ask support to add your language if missing., * ca - Catalan, * da - Danish, * nl - Dutch, * fa - French, * de - German, * es - Spanish, * en - English, * he - Hebrew, * pl - Polish, * pt - Portuguese, * ru - Russian, * sv - Swedish, * tr - Turkish, * lt - Lithuanian (This can only be one of ca,da,nl,fa,de,es,en,he,pl,pt,ru,sv,tr,lt)
Output Type
 OutputType string

This property is used to determine how the OCR layer should be returned. If the output type is PDF, the OCR layer will be embedded into the PDF file. Alternatively, if a text output is selected, the OCR layer will be returned as a text file., * pdf - PDF file, * txt - Text file (This can only be one of pdf,txt)
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Add text watermark to PDF

Operation ID:
convertPdfToWatermark

Overlay a text watermark or stamp onto PDF pages. Configure font, rotation, color, alignment, and optional linking. Works under or over page content.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be watermarked.
Color Space
 ColorSpace string

Set PDF color space., * Default - Default, * RGB - RGB, * CMYK - CMYK, * Gray - Gray (This can only be one of Default,RGB,CMYK,Gray)
Crop Box
 CropBox boolean

Specifies whether to use the page crop box to position watermark.
Embed Fonts
 EmbedFonts boolean

Embed fonts in PDF.
File Name
 FileName string

Set the output file name (optional)
Font Color
 FontColor string

Specifies the watermark font color.
Font Embed
 FontEmbed boolean

Specifies whether fonts should be embedded.
Font Encoding
 FontEncoding string

Specifies the font encoding.
Font Name
 FontName string

Specifies the watermark font name. Contact us if you are looking for a specific font for a watermark that is missing from the list., * Arial - Arial, * Bahnschrift - Bahnschrift, * Calibri - Calibri, * Cambria - Cambria, * Consolas - Consolas, * Constantia - Constantia, * Courier New - Courier New, * Georgia - Georgia, * Tahoma - Tahoma, * Times New Roman - Times New Roman, * Verdana - Verdana
Font Size
 FontSize integer

Specifies the watermark font size.
Font Subset
 FontSubset boolean

Specifies whether fonts should be subset.
Go To Link
 GoToLink string

Specifies the web address to go when the watermark is clicked.
Go To Page
 GoToPage string

Specifies the page number to go when the watermark is clicked.
Horizontal Alignment
 HorizontalAlignment string

Specifies the horizontal watermark alignment., * left - left, * center - center, * right - right (This can only be one of left,center,right)
Opacity
 Opacity integer

Specifies watermark opacity level.
Open Page
 OpenPage integer

Set the page number at which the PDF document should open.
Open Zoom
 OpenZoom string

Set the default zoom percentage for when you open PDF files ., * Default - Default, * ActualSize - Actual Size, * FitPage - Fit Page, * FitWidth - Fit Width, * FitHeight - Fit Height, * FitVisible - Fit Visible, * 25 - 25%, * 50 - 50%, * 75 - 75%, * 100 - 100%, * 125 - 125%, * 150 - 150%, * 200 - 200%, * 400 - 400%, * 800 - 800%, * 1600 - 1600%, * 2400 - 2400%, * 3200 - 3200%, * 6400 - 6400%
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Page Rotation
 PageRotation boolean

Specifies whether to use the page rotation parameter when placing watermark.
Password
 Password string

Sets the password to open protected documents.
PDF author
 PdfAuthor string

Provide a value to customize the PDF author. Otherwise, the default document author will be used. Use single quotes and a space (' ') to remove the author.
PDF keywords
 PdfKeywords string

Provide a value to customize the PDF keywords. Otherwise, the default document keywords will be used. Use single quotes and a space (' ') to remove the keywords.
PDF resolution
 PdfResolution integer

Set PDF resolution.
PDF subject
 PdfSubject string

Provide a value to customize the PDF subject. Otherwise, the default document subject will be used. Use single quotes and a space (' ') to remove the subject.
PDF title
 PdfTitle string

Provide a value to customize the PDF title. Otherwise, the default document title will be used. Use single quotes and a space (' ') to remove the title.
PDF version
 PdfVersion string

Set PDF version., * 1.2 - Acrobat 3 (PDF 1.2), * 1.3 - Acrobat 4 (PDF 1.3), * 1.4 - Acrobat 5 (PDF 1.4), * 1.5 - Acrobat 6 (PDF 1.5), * 1.6 - Acrobat 7 (PDF 1.6), * 1.7 - Acrobat 8 (PDF 1.7), * 1.8 - Acrobat 9 (PDF 1.7, e-level 3), * 2.0 - Acrobat DC (PDF 2.0)
Position Unit
 PositionUnit string

Specifies measurement unit to use for the PositionX and PositionY properties., * pt - points, * in - inches, * mm - millimeters, * cm - centimeters (This can only be one of pt,in,mm,cm)
Watermark X coordinate
 PositionX integer

Specifies the watermark X coordinate. If set overrides property HorizontalAlignment.
Watermark Y coordinate
 PositionY integer

Specifies the watermark Y coordinate. If set overrides property VerticalAlignment.
Watermark rotation angle
 Rotate integer

Specifies the watermark rotation angle in degrees.
Rotate Page
 RotatePage string

Automatically rotate pages based on the orientation of the text. By Page option will rotate each page based on the direction of the text on that page. All option will rotate all pages in the document based on the orientation of the majority of text., * Disabled - Disabled, * ByPage - By Page, * All - All (This can only be one of Disabled,ByPage,All)
Stroke Color
 StrokeColor string

Specifies font stroke color.
Stroke Width
 StrokeWidth integer

Specifies the stroke width.
Watermark style
 Style string

Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content., * stamp - stamp, * watermark - watermark (This can only be one of stamp,watermark)
Word Wrap
 WordWrap boolean

Specifies whether to enable word wrap in case text does not fit in one line.
Subset Fonts
 SubsetFonts boolean

Include in the output PDF document only the font characters that are used in the original document.
Subset Fonts Threshold
 SubsetFontsThreshold integer

Sets the Subset Fonts threshold. If the percentage of used characters, compared with total characters of the particular font, exceeds this threshold, the entire font is embedded.
Text
 Text True string

(Required)
Text Rendering Mode
 TextRenderingMode string

Specifies the text rendering mode., * filltext - fill text without stroke, * stroketext - stroke text without fill, * fillstroke - fill and stroke, * invisible - invisible
Vertical Alignment
 VerticalAlignment string

Specifies the vertical watermark alignment., * top - top, * center - center, * bottom - bottom (This can only be one of top,center,bottom)
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Compress a PDF file

Operation ID:
convertPdfToCompress

Reduce PDF file size by adjusting image quality, resolution, removing duplicate resources, or applying various compression presets.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be compressed.
File Name
 FileName string

Set the output file name (optional)
Image Quality
 ImageQuality number

Set image quality in percentage.
Image Resolution
 ImageResolution number

Set the maximum image resolution in DPI.
Linearize PDF
 Linearize boolean

Linearize PDF file and optimize for fast Web View.
Optimize content streams
 Optimize boolean

Optimize page content streams in the PDF file.
Password
 Password string

Sets the password to open protected PDF.
Preserve PDF/A
 PreservePdfa boolean

Preserve the PDF/A standard in the PDF file.
Preset
 Preset string

Choose a compression level from the available presets. If a preset is selected, all other compression options will be ignored. These presets are optimized for various use cases, such as balancing file size and quality., * none - Not set - advanced properties used, * text - Text - 20 image DPI, lowest quality, highest compression, * archive - Archive - 40 image DPI, low quality, high compression, * web - Web - 75 image DPI, medium quality, high compression, * ebook - Ebook - 150 image DPI, high quality, medium compression, * printer - Printer - 300 image DPI, high quality, low compression (This can only be one of none,text,archive,web,ebook,printer)
Remove Duplicates
 RemoveDuplicates boolean

Remove duplicate fonts and color profiles from the PDF file.
Remove Embedded Files
 RemoveEmbeddedFiles boolean

Remove embedded/attachments files from the PDF file.
Remove Forms
 RemoveForms boolean

Remove PDF forms from the PDF file.
Remove Metadata
 RemoveMetadata boolean

Detach the XMP metadata embedded in the document from its catalog, clear all properties in all schemas, and remove metadata from marked content.
Remove Piece Information
 RemovePieceInformation boolean

Remove piece information dictionaries like Adobe Illustrator or Photoshop private data.
Remove Structure Information
 RemoveStructureInformation boolean

Remove all structure information from the PDF document.
Remove Unused Resources
 RemoveUnusedResources boolean

Remove references to resources such as fonts, images, patterns.
Subset Embedded Fonts
 SubsetEmbeddedFonts boolean

Output PDF should only contain font characters utilized in the original document, and any unused glyphs from all fonts in the document should be removed.
Unembed Base Fonts
 UnembedBaseFonts boolean

Specifies whether to remove the base fonts from the PDF file.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to CSV

Operation ID:
convertPdfToCsv

Extract tables from textual or scanned PDF documents to CSV format. Optionally apply OCR to handle scanned pages, define a delimiter, and set page ranges.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be converted.
Delimiter
 Delimiter True string

(Required) Set fields separator.
Enable OCR
 EnableOcr string

Enable optical character recognition(OCR). Set the property to ALL to perform OCR on all pages and Scanned to perform OCR on scanned pages if PDF contains mixed pages - text and image pages., * Scanned - Scanned Only, * All - All Pages, * None - None
File Name
 FileName string

Set the output file name (optional)
OCR Language
 OcrLanguage string

Set the OCR language. Ask support to add your language if missing., * ca - Catalan, * da - Danish, * nl - Dutch, * fa - French, * de - German, * es - Spanish, * en - English, * he - Hebrew, * pl - Polish, * pt - Portuguese, * ru - Russian, * sv - Swedish, * tr - Turkish, * lt - Lithuanian (This can only be one of ca,da,nl,fa,de,es,en,he,pl,pt,ru,sv,tr,lt)
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to DOCX

Operation ID:
convertPdfToDocx

Transform PDF files into editable Word documents. Optionally apply OCR to scanned PDFs, define page ranges, or preserve layout with text boxes (WYSIWYG).

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be converted.
File Name
 FileName string

Set the output file name (optional)
Enable OCR
 EnableOcr boolean

Enable optical character recognition(OCR).
OCR Language
 OcrLanguage string

Configure the OCR language for text recognition. If auto-detection fails, manually specify the language. * automatic - Automatic, * ar - Arabic, * ca - Catalan, * zh - Chinese, * da - Danish, * nl - Dutch, * en - English, * fi - Finnish, * fr - French, * de - German, * gr - Greek, * ko - Korean, * it - Italian, * ja - Japanese, * no - Norwegian, * pl - Polish, * pt - Portuguese, * ro - Romanian, * ru - Russian, * sl - Slovenian, * es - Spanish, * sv - Swedish, * tr - Turkish, * th - Thai
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Wysiwyg
 Wysiwyg boolean

Persist exact formatting using text boxes.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to JPG

Operation ID:
convertPdfToJpg

Render each page of a PDF as a JPG image. Control resolution, color space (RGB, CMYK, Gray), image width/height, and page rotation if needed.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be converted.
File Name
 FileName string

The FileName property defines the name of the output file(s) generated by the file conversion API, ensuring safe and unique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the correct file extension based on the target format, and includes an indexing feature to distinguish multiple output files from a single input. For example, converting report.docx to PDF format might result in report.pdf for a single file, or report_0.pdf, report_1.pdf for multiple files, ensuring each output file is uniquely identifiable.
Color Space
 ColorSpace string

Set image color space., * rgb - RGB, * cmyk - CMYK, * gray - Gray (This can only be one of rgb,cmyk,gray)
Crop To
 CropTo string

Defines the options for cropping the page., * BoundingBox - Bounding Box, * TrimBox - Trim Box, * MediaBox - Media Box, * ArtBox - Art Box, * BleedBox - Bleed Box
Image Height
 ImageHeight integer

Image height in pixels.
Image Quality
 ImageQuality integer

Set output image quality.
Image Resolution
 ImageResolution integer

Set output image resolution in dpi.
Image Width
 ImageWidth integer

Image width in pixels.
Page Range
 PageRange string

Set PDF page range to convert. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected PDF.
Rotate
 Rotate string

Set PDF page rotation before converting to image., * default - Default, * none - None, * rotate90 - Rotate 90, * rotate180 - Rotate 180, * rotate270 - Rotate 270
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to PDFA

Operation ID:
convertPdfToPdfa

Convert PDF to an archival PDF/A format (e.g., PDF/A-1b, PDF/A-2u). Adjust metadata, title, author, keywords, and output intent.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be converted.
File Name
 FileName string

Set the output file name (optional)
PDF Author
 PdfAuthor string

Provide a value to customize the PDF author. Otherwise, the default document author will be used. Use single quotes and a space (' ') to remove the author.
PDF keywords
 PdfKeywords string

Provide a value to customize the PDF keywords. Otherwise, the default document keywords will be used. Use single quotes and a space (' ') to remove the keywords.
PDF subject
 PdfSubject string

Provide a value to customize the PDF subject. Otherwise, the default document subject will be used. Use single quotes and a space (' ') to remove the subject.
PDF title
 PdfTitle string

Provide a value to customize the PDF title. Otherwise, the default document title will be used. Use single quotes and a space (' ') to remove the title.
PDF/A output intent
 PdfaOutputIntent string

Set PDF/A output intent. These are supported sRGB, Japan Color 2001 Coated (JC200103), Europe ISO Coated (FOGRA27), U.S. Web Coated (SWOP), Gray Gamma 2.2 (GRAY)., * srgb - sRGB, * jc200103 - Japan Color 2001 Coated, * fogra27 - Europe ISO Coated, * swop - U.S. Web Coated, * gray - Gray Gamma 2.2 (This can only be one of srgb,jc200103,fogra27,swop,gray)
PDF/A version
 PdfaVersion string

Set PDF/A version., * pdfa - PDF/A-1b, * pdfa2 - PDF/A-2b, * pdfa2u - PDF/A-2u, * pdfa3 - PDF/A-3b, * pdfa3u - PDF/A-3u (This can only be one of pdfa,pdfa2,pdfa2u,pdfa3,pdfa3u)
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to plain text

Operation ID:
convertPdfToTxt

Extract text from a PDF into a TXT file. Optionally enable OCR, remove headers/footers, ignore tables, or specify page ranges.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be converted.
Enable OCR
 EnableOcr boolean

Enable optical character recognition(OCR).
File Name
 FileName string

Set the output file name (optional)
Include Formatting
 IncludeFormatting boolean

Persist formatting while extracting text. Only works when RemoveHeadersFooters and RemoveFootnotes properties are disabled.
OCR Language
 OcrLanguage string

Configure the OCR language for text recognition. If auto-detection fails, manually specify the language., * automatic - Automatic, * ar - Arabic, * ca - Catalan, * zh - Chinese, * da - Danish, * nl - Dutch, * en - English, * fi - Finnish, * fr - French, * de - German, * gr - Greek, * ko - Korean, * it - Italian, * ja - Japanese, * no - Norwegian, * pl - Polish, * pt - Portuguese, * ro - Romanian, * ru - Russian, * sl - Slovenian, * es - Spanish, * sv - Swedish, * tr - Turkish, * th - Thai (This can only be one of automatic,ar,ca,zh,da,nl,en,fi,fr,de,gr,ko,it,ja,no,pl,pt,ro,ru,sl,es,sv,tr,th)
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Remove Footnotes
 RemoveFootnotes boolean

Remove footnotes from the document.
Remove Headers Footers
 RemoveHeadersFooters boolean

Remove headers and footers from the document.
Remove Tables
 RemoveTables boolean

Remove tables from the document.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to PNG

Operation ID:
convertPdfToPng

Render PDF pages to PNG images. Control crop boxes, resolution, page ranges, and password protection.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be converted.
Background Color
 BackgroundColor string

Applies a color to the transparent PDF background, thereby setting the background color of the generated images. You can specify a color name (e.g. white or black), or use color codes such as RGB (e.g. 255,0,0) or HEX (e.g.
Crop To
 CropTo string

Defines the options for cropping the page., * BoundingBox - Bounding Box, * TrimBox - Trim Box, * MediaBox - Media Box, * ArtBox - Art Box, * BleedBox - Bleed Box
File Name
 FileName string

Set the output file name (optional)
Image Height
 ImageHeight integer

Image height in pixels.
Image Resolution
 ImageResolution integer

Set output image resolution in dpi.
Image Width
 ImageWidth integer

Image width in pixels.
Page Range
 PageRange string

Set PDF page range to convert. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected PDF.
PDF page rotation
 Rotate string

Set PDF page rotation before converting to image., * default - Default, * none - None, * rotate90 - Rotate 90, * rotate180 - Rotate 180, * rotate270 - Rotate 270
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to PPTX

Operation ID:
convertPdfToPptx

Transform PDF pages into PowerPoint slides. Apply OCR to scanned PDFs, define page ranges, and handle password protection.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be converted.
Enable OCR
 EnableOcr boolean

Enable optical character recognition(OCR).
File Name
 FileName string

Set the output file name (optional)
OCR Language
 OcrLanguage string

Configure the OCR language for text recognition. If auto-detection fails, manually specify the language., * automatic - Automatic, * ar - Arabic, * ca - Catalan, * zh - Chinese, * da - Danish, * nl - Dutch, * en - English, * fi - Finnish, * fr - French, * de - German, * gr - Greek, * ko - Korean, * it - Italian, * ja - Japanese, * no - Norwegian, * pl - Polish, * pt - Portuguese, * ro - Romanian, * ru - Russian, * sl - Slovenian, * es - Spanish, * sv - Swedish, * tr - Turkish, * th - Thai (This can only be one of automatic,ar,ca,zh,da,nl,en,fi,fr,de,gr,ko,it,ja,no,pl,pt,ro,ru,sl,es,sv,tr,th)
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Convert PDF to XLSX

Operation ID:
convertPdfToXlsx

Extract tables and text from PDF to Excel (XLSX). Optionally apply OCR to scanned PDFs, specify page ranges, or combine tables into one sheet.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be watermarked.
Enable OCR
 EnableOcr boolean

Enable optical character recognition(OCR).
File Name
 FileName string

Set the output file name (optional)
Include Formatting
 IncludeFormatting boolean

Include non-table content in an excel file, like images and paragraphs.
OCR Language
 OcrLanguage string

Configure the OCR language for text recognition. If auto-detection fails, manually specify the language., * automatic - Automatic, * ar - Arabic, * ca - Catalan, * zh - Chinese, * da - Danish, * nl - Dutch, * en - English, * fi - Finnish, * fr - French, * de - German, * gr - Greek, * ko - Korean, * it - Italian, * ja - Japanese, * no - Norwegian, * pl - Polish, * pt - Portuguese, * ro - Romanian, * ru - Russian, * sl - Slovenian, * es - Spanish, * sv - Swedish, * tr - Turkish, * th - Thai (This can only be one of automatic,ar,ca,zh,da,nl,en,fi,fr,de,gr,ko,it,ja,no,pl,pt,ro,ru,sl,es,sv,tr,th)
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Single Sheet
 SingleSheet boolean

Combine extracted tables into a single sheet.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Extract images from PDF

Operation ID:
convertPdfToExtractImages

Retrieve embedded images from each page of a PDF. Configure output image format, resolution, and page ranges. Works with password-protected PDFs as well.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File from which you want to extract the images.
File Name
 FileName string

Set the output file name (optional)
Image Output Format
 ImageOutputFormat string

, * default - Default, * jpg - JPG, * png - PNG, * tiff - TIFF
Image Resolution
 ImageResolution integer

Set output image resolution in dpi.
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Flatten PDF

Operation ID:
convertPdfToFlatten

Flatten a PDF to make form fields, annotations, and text layers static. Optionally convert editable text to vector paths to protect content from selection or copying.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be flattened.
File Name
 FileName string

Set the output file name (optional)
Flatten Text
 FlattenText boolean

Prevent text selection, copying, and extraction by turning the textual symbols into vectorial paths to make the PDF read-only while preserving the original vectorial PDF quality.
Password
 Password string

Sets the password to open protected documents.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Merge multiple PDFs

Operation ID:
convertPdfToMerge

Combine multiple PDF files into a single PDF. Configure page size, orientation, bookmarks, and more. Supports up to five input files in this definition (Files[0]–Files[4]).

Parameters

Name Key Required Type Description
First file
 Files[0] True file

First file to be merged
Second file
 Files[1] True file

Second file to be merged
Third file
 Files[2] file

Third file to be merged
Fourth file
 Files[3] file

Fourth file to be merged
Fifth file
 Files[4] file

Fifth file to be merged
Bookmarks TOC
 BookmarksToc string

Adds a top-level bookmark for each file, using the filename or PDF title from metadata., * disabled - Disabled, * filename - File Name, * title - Title (This can only be one of disabled,filename,title)
File Name
 FileName string

Set the output file name (optional)
Open Page
 OpenPage integer

Set the page number at which the PDF document should open.
Page Orientation
 PageOrientation string

Set page orientation., * default - Default, * portrait - Portrait, * landscape - Landscape (This can only be one of default,portrait,landscape)
Page Size
 PageSize string

The property scales each page to fit a given page size., * default - Default, * a2 - A2, * a3 - A3, * a4 - A4, * a5 - A5, * a6 - A6, * letter - Letter, * legal - Legal
Password
 Password string

Sets the password to open protected PDF.
Remove Duplicate Fonts
 RemoveDuplicateFonts boolean

Do not include the same fonts from source PDFs while merging.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Overlay PDF watermark

Operation ID:
convertPdfToWatermarkOverlay

Use another PDF as a watermark or stamp overlay. Adjust opacity, position, page range, and more. Ideal for adding logos or disclaimers.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be watermarked.
Overlay File
 OverlayFile True file

(Required) Specifies the PDF file to use as overlay. Value can be URL or file content.
File Name
 FileName string

Set the output file name (optional)
Go To Link
 GoToLink string

Specifies the web address to go when the watermark is clicked.
Go To Page
 GoToPage string

Specifies the page number to go when the watermark is clicked.
Horizontal Alignment
 HorizontalAlignment string

Specifies the horizontal watermark alignment., * left - left, * center - center, * right - right (This can only be one of left,center,right)
Opacity
 Opacity integer

Specifies watermark opacity level.
Open Zoom
 OpenZoom string

Set the default zoom percentage for when you open PDF files ., * Default - Default, * ActualSize - Actual Size, * FitPage - Fit Page, * FitWidth - Fit Width, * FitHeight - Fit Height, * FitVisible - Fit Visible, * 25 - 25%, * 50 - 50%, * 75 - 75%, * 100 - 100%, * 125 - 125%, * 150 - 150%, * 200 - 200%, * 400 - 400%, * 800 - 800%, * 1600 - 1600%, * 2400 - 2400%, * 3200 - 3200%, * 6400 - 6400%
Overlay Page
 OverlayPage integer

Specifies the page to use as overlay from the OverlayFile file.
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Page Rotation
 PageRotation boolean

Specifies whether to use the page rotation parameter when placing watermark.
Password
 Password string

Sets the password to open protected documents.
PDF Author
 PdfAuthor string

Provide a value to customize the PDF author. Otherwise, the default document author will be used. Use single quotes and a space (' ') to remove the author.
PDF Keywords
 PdfKeywords string

Provide a value to customize the PDF keywords. Otherwise, the default document keywords will be used. Use single quotes and a space (' ') to remove the keywords.
Position Unit
 PositionUnit string

Specifies measurement unit to use for the PositionX and PositionY properties., * pt - points, * in - inches, * mm - millimeters, * cm - centimeters (This can only be one of pt,in,mm,cm)
Watermark X coordinate
 PositionX integer

Specifies the watermark X coordinate. If set overrides property HorizontalAlignment.
Watermark Y coordinate
 PositionY integer

Specifies the watermark Y coordinate. If set overrides property VerticalAlignment.
Scale
 Scale integer

Specifies the watermark scale in percent.
Style
 Style string

Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content., * stamp - stamp, * watermark - watermark (This can only be one of stamp,watermark)
Vertical Alignment
 VerticalAlignment string

Specifies the vertical watermark alignment., * top - top, * center - center, * bottom - bottom (This can only be one of top,center,bottom)
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Protect a PDF

Operation ID:
convertPdfToProtect

Add encryption and set permissions on a PDF. Restrict printing, copying, or modifying. Configure owner/user passwords and encryption algorithms (RC4, AES, etc.).

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be protected.
Allow Everything
 AllowEverything boolean

Enable or disable all permissions. The specific permissions listed below overrides this property.
Assemble Document
 AssembleDocument boolean

Enable or disable assembly of the document - insert, rotate, or delete pages and create bookmarks or thumbnail images.
Copy Contents
 CopyContents boolean

Enable or disable copy or extract text and graphics from the document.
Encrypt Meta
 EncryptMeta boolean

Encrypt metadata of PDF file.
Encryption Algorithm
 EncryptionAlgorithm string

Sets the encryption algorithm., * Standard40Bit - 40-bit RC4 algorithm. Acrobat 3 (PDF 1.1) and above, * Standard128Bit - 128-bit RC4 algorithm. Acrobat 5 (PDF 1.4) and above, * Aes128Bit - 128-bit AES algorithm. Acrobat 7 (PDF 1.6) and above, * Aes256Bit - 256-bit AES algorithm. PDF 2.0
Extract Contents
 ExtractContents boolean

Enable or disable extract text and graphics.
File Name
 FileName string

Set the output file name (optional)
Fill Form Fields
 FillFormFields boolean

Enable or disable fill-in existing interactive form fields, including signature fields.
Modify Annotations
 ModifyAnnotations boolean

Enable or disable adding or modifying text annotations and fill in interactive form fields.
Modify Contents
 ModifyContents boolean

Enable or disable changing the contents of the document.
Owner Password
 OwnerPassword string

Sets owner password (also known as a permissions password). Using a owner password, you can restrict printing, editing, and copying content in the PDF. Recipients don’t need a password to open the document. They do need a password to change the restrictions the owner set.
Password
 Password string

Sets the password to open protected documents.
Preserve Permissions
 PreservePermissions boolean

Enable the property if you want to keep the document permissions unchanged. It requires you to specify the OwnerPassword. If enabled, the document permission properties will be ignored.
Print Document
 PrintDocument boolean

Enable or disable document printing.
Print Faithful Copy
 PrintFaithfulCopy boolean

Enable or disable printing of the document to a representation from which a faithful digital copy of the PDF content could be generated.
Respect Owner Password
 RespectOwnerPassword string

Enable the property if you want to respect the document's owner password and permissions. If disabled - the old owner's password and permissions will be removed by default. Setting this property requires you to enter the correct owner's password into the Password property for protected documents.
User Password
 UserPassword string

Sets the user password (also known as a document open password) in the output PDF document. Users will be asked to enter this password before Acrobat Reader allows them to view the PDF document.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Redact PDF

Operation ID:
convertPdfToRedact

Permanently remove or hide sensitive data from a PDF. Use AI-based detection or supply custom RedactionData. Optionally specify page ranges.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be redacted.
File Name
 FileName string

Set the output file name (optional)
Minimum Confidence
 MinimumConfidence string

Sets the minimum confidence threshold for AI-based detection of sensitive data. Higher values reduce false positives but may miss subtle matches.
Page Range
 PageRange string

Set page range. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected PDF.
Presets
 Presets string

, * auto - All types of documents, * disabled - AI will not search Sensitive Data, * invoice - Invoice / Billing Document, * agreement - Contract / Agreement, * tax - Government / Tax Form, * healthcare - Medical / Healthcare Document, * statement - Financial Statement, * employee - HR / Employee Document (This can only be one of auto,disabled,invoice,agreement,tax,healthcare,statement,employee)
Redaction Data
 RedactionData string

A JSON array defining specific values for redaction. For more information please refer to https://www.convertapi.com/pdf-to-redact
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Remove pages from PDF

Operation ID:
convertPdfToDeletePages

Delete specific pages from a PDF document using a page range or comma-separated page list. Also supports password-protected PDFs.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File of which you want to delete specific pages.
File Name
 FileName string

Set the output file name (optional)
Page Range
 PageRange True string

(Required) Set page range or individual pages to delete. Example 1-10 or 1,2,5.
Password
 Password string

Sets the password to open protected documents.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Remove PDF protection

Operation ID:
convertPdfToUnprotect

Remove password-based restrictions from a PDF. Enter the user password to remove user-level security or leave empty to remove only owner-level restrictions.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be unprotected.
File Name
 FileName string

Set the output file name (optional)
Password
 Password string

Enter user password to remove User protection. Leave the parameter empty to remove Owner protection.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Rotate PDF pages

Operation ID:
convertPdfToRotate

Rotate selected PDF pages by 90, 180, or 270 degrees. Optionally specify page ranges and handle password protection.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to which you want to apply page rotation.
File Name
 FileName string

Set the output file name (optional)
Page Range
 PageRange string

Set page range. Example 1-10.
Password
 Password string

Sets the password to open protected documents.
Rotate Page
 RotatePage string

Rotates page(s) by selected degree., * -270 - -270 degree, * -90 - -90 degree, * 90 - 90 degree, * 180 - 180 degree, * 270 - 270 degree (This can only be one of -270,-90,90,180,270)
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string

Split PDF

Operation ID:
convertPdfToSplit

Break a PDF into multiple files using custom ranges, patterns, or text searches. Optionally compress output or merge extracted ranges into one file.

Parameters

Name Key Required Type Description
File
 File True file

(Required) File to be split.
Compress PDF
 CompressPDF boolean

It tries to produce smaller output files but requires Adobe Reader 6, released in 2003 or newer, to view created PDF files.
Extract Pages
 ExtractPages string

Each page included in this range will be split individually (one page per document). A page range or individual page numbers separated by a comma is supported (see SplitByCustomRange description for a detailed explanation).
File Name
 FileName string

Set the output file name (optional)
Merge Ranges
 MergeRanges boolean

Merge all ranges in one PDF file.
Password
 Password string

Sets the password to open protected documents.
Split By Custom Range
 SplitByCustomRange string

Split PDF by a custom range. Individual page numbers separated by commas or page ranges are supported and can be combined. For example, if you set 1,3,4-5,6-9 for a ten-page PDF, it would create four PDF documents - the first PDF contains only the first page, the second PDF contains the third page, the third PDF contains pages from 3 to 5, and the last PDF contains pages from 6 to 9.
Split By Pattern
 SplitByPattern string

Split PDF into chunks of pages by a pattern. For example, if you set 3,2 for a ten-page PDF, it would be divided into four PDF files that contain 3,2,3,2 pages accordingly. The pattern is repeated until there are no pages left.
Split By Text Pattern
 SplitByTextPattern string

Split PDF by identifying text segments matching a specific regex pattern. This allows the document to be divided into separate files at each occurrence of the specified pattern, ideal for segmenting content by recurring headings, section labels, or custom text markers.
Store File
 StoreFile boolean

Store converted file on our secure server and provides download URL.

Returns

Name Path Type Description
ConversionCost
 ConversionCost integer
Files
 Files array of object
FileData
 Files.FileData string
FileExt
 Files.FileExt string
FileId
 Files.FileId string
FileName
 Files.FileName string
FileSize
 Files.FileSize integer
Url
 Files.Url string