Dela via

PDFco

  • Reference

PDF.co is the set of PDF tools from Data extraction to Document Parser. Generate PDF, Read unstructured PDF, Fill PDF Forms, Add Text/Images to PDF, Split PDF, Merge PDF, Convert Pdf tables to CSV, JSON, XML and much more.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   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)
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)
Contact
Name PDF.co Support
URL https://support.bytescout.com
Email plugins@bytescout.com
Connector Metadata
Publisher PDF.co
Website https://pdf.co/
Privacy policy https://pdf.co/pages/legal/privacy
Categories Productivity;Data

PDF.co connector provides operations for Merge PDF, Split PDF, HTML to PDF, URL to PDF and modifying PDF. Merge PDF supports merging different types of documents to PDF format. For modifying PDF, it supports adding text/images to PDF and also filling out PDF forms.

Prerequisites

PDF.co requires API Key for authentication of its requests.

How to get credentials

PDF.co API key can be obtained by signing-up with PDF.co.

  • Login to your PDF.co account at https://app.pdf.co
  • After login API Key can be found at "View Your API Key" section.

Get started with your connector

PDF.co connector consists of following actions.

  • HTML to PDF

    HTML to PDF action converts raw HTML to PDF format. Apart from that we can also configure advanced options such as output paper size, orientation of PDF page, margins, custom header and footer, etc.

  • URL to PDF

    As the name suggests, URL to PDF action converts website URL to PDF document. We can configure advanced settings for output page margins, orientation, header and footer, etc.

  • Split PDF

    This action is to split input PDF into multiple pages. We need to specify the “Pages” parameter for how many output pages are required.

  • Merge PDF

    This action merges documents to a PDF file. Here, documents can be of different formats such as pdf, doc, text, excel, zip, etc. Input parameter “URL” requires comma separated document URLs.

  • PDF Filler

    PDF Filler action modifies existing PDF document. With use of this action, we can add Text/Images to existing PDF as well fill PDF forms fields. We have to pass values in a specific format. For more information please visit pdf.co official documentation.

Known issues and limitations

In this initial version of PDF.co connector, only few PDF.co features are covered. One of the features missing in this initial version, is to check async job status and get completed job results.

Common errors and remedies

  • Input URL passed to PDF.co Action must be a valid and publicly accessible URL.

  • If PDF.co request returns 401 - unauthorized result, make sure you have provided valid PDF.co API key.

  • All requests deduct your PDF.co credits based on request processing. Hence, if your PDF.co account does not have enough credits, it’ll result in error.

FAQ

Please refer to PDF.co Knowledgebase for all QAs.

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
API Key securestring The API KEY for this Endpoint True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add Text, Images, Form Fields to PDF

Add text, images, signatures to pdf. Fill PDF form fields and create new pdf from templates. Please see api documentation at https://developer.pdf.co/api/pdf-add/index.html for comprehensive guidelines.
Background Jobs Check

Checks status of background job that was previously created with PDF.co API. Please see api documentation at https://developer.pdf.co/api/background-job-check/index.html for comprehensive guidelines.
Barcode Generator

Generate high quality barcode images. Supports QR Code, Datamatrix, Code 39, Code 128, PDF417 and many other barcode types. Please see api documentation at https://developer.pdf.co/api/barcode-generator/index.html for comprehensive guidelines.
Barcode Reader

Read barcodes from images and PDF. Can read all popular barcode types from QR Code and Code 128, EAN to Datamatrix, PDF417, GS1 and many other barcodes. Please see api documentation at https://developer.pdf.co/api/barcode-reader/index.html for comprehensive guidelines.
Document Classifier

Auto classification Of Incoming Documents based on keywords-based rules. For example, you can define rules to find which vendor provided the document to find which template to apply accordingly. Please see api documentation at https://developer.pdf.co/api/document-classifier/index.html for comprehensive guidelines.
Document Parser

Document Parser can automatically parse PDF, JPG, and PNG documents to extract fields, tables, values, and barcodes from invoices, statements, orders, and other PDF and scanned documents. Please see api documentation at https://developer.pdf.co/api/document-parser/index.html for comprehensive guidelines.
Email Attachment Extraction

Extract Email attachments with basic email information. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments for comprehensive guidelines.
Email Information

Get Email Information such as sender/recipient, subject, body, etc. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode for comprehensive guidelines.
HTML to PDF

Convert HTML code snippet into full featured PDF. Please see api documentation at https://developer.pdf.co/api/pdf-to-html/index.html for comprehensive guidelines.
Make Scanned PDF to Text Searchable

Turn PDF and scanned JPG, PNG images into text-searchable PDF. Please see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable for comprehensive guidelines.
Merge PDF

Merge PDF from two or more PDF files into a new one. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html for comprehensive guidelines.
Merge PDF (Advanced)

Merge PDF from two or more pdf, doc, xls, images, even zip with documents and images into a new PDF. Supports zip, doc, docx, xls, xlsx, rtf, txt, png, jpg. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 for comprehensive guidelines.
PDF Add Security

Add password and security limitations to existing PDF. Please see api documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add for comprehensive guidelines.
PDF Attachment Extraction

Extract attachments from input PDF document. Please see api documentation at https://developer.pdf.co/api/extract-attachments/index.html for comprehensive guidelines.
PDF Compress and Optimize

Optimize PDF document to reduce its size. Please see api documentation at https://developer.pdf.co/api/pdf-optimize/index.html for comprehensive guidelines.
PDF Delete Pages

Delete pages in PDF. Please see api documentation at https://developer.pdf.co/api/pdf-delete-pages/index.html for comprehensive guidelines.
PDF Find Table

AI powered document analysis can scan your document for tables and return the array of tables on pages with coordinates and information about columns detected in these tables. Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table for comprehensive guidelines.
PDF Forms Info Reader

Get information about fillable fields inside PDF form file. Please see api documentation at https://developer.pdf.co/api/pdf-forms-info-reader/index.html for comprehensive guidelines.
PDF from CSV

Convert CSV document to PDF. Works also with XLS or XLSX input. Please see api documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv for comprehensive guidelines.
PDF from Document (Doc, DocX, RTF, TXT, XPS)

Convert DOC, DOCX, RTF, TXT, XPS files into PDF. Please see api documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc for comprehensive guidelines.
PDF from Email

Convert email files (MSG or EML) code into PDF. Extracts attachments (if any) from input email and embeds into PDF as pdf attachments. Please see api documentation at https://developer.pdf.co/api/pdf-from-email/index.html for comprehensive guidelines.
PDF from Image

Create a PDF file from one or more JPG, PNG, TIFF images. Please see api documentation at https://developer.pdf.co/api/pdf-from-image/index.html for comprehensive guidelines.
PDF From Spreadsheet

Create PDF from XLS, XLSX spreadsheet. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf for comprehensive guidelines.
PDF Info Reader

Get detailed information about the PDF document, it's properties and security permissions. Please see api documentation at https://developer.pdf.co/api/pdf-info-reader/index.html for comprehensive guidelines.
PDF Remove Security

Remove password and security from existing PDF files. Please see api documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove for comprehensive guidelines.
PDF Search and Delete Text from PDF

Search text in PDF and remove found text from PDF. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-delete-text/index.html for comprehensive guidelines.
PDF Search and Replace Text

Modify a PDF file by searching for specific text and replacing it with new text. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text for comprehensive guidelines.
PDF Search and Replace Text with Image

Replace specific text in a PDF document with an image. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image for comprehensive guidelines.
PDF Search Text

Search text in PDF and get coordinates. Supports regular expressions. Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html for comprehensive guidelines.
PDF To CSV

Convert PDF and scanned images into CSV representation with layout, columns, rows, and tables. Please see api documentation at https://developer.pdf.co/api/pdf-to-csv/index.html for comprehensive guidelines.
PDF to JPG

PDF to JPG conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg for comprehensive guidelines.
PDF To JSON

Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-json/index.html for comprehensive guidelines.
PDF To JSON (AI Powered)

Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta for comprehensive guidelines.
PDF to PNG

PDF to PNG conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png for comprehensive guidelines.
PDF to Scanned PDF

Convert PDF to Scanned PDF. Result PDF is same as if you printed and then scanned your PDF. Please see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable for comprehensive guidelines.
PDF To Text (with layout and ocr)

Convert PDF and scanned images to Text with layout preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html for comprehensive guidelines.
PDF To Text (without layout and ocr)

Convert PDF to plain text without layout preserved and OCR support. Please see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple for comprehensive guidelines.
PDF to TIFF

PDF to high quality TIFF images conversion. High quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff for comprehensive guidelines.
PDF to WEBP

PDF to WEBP conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp for comprehensive guidelines.
PDF To XLS

Convert PDF and scanned images to spreadsheet with layout and fonts preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls for comprehensive guidelines.
PDF To XLSX

Convert PDF and scanned images to spreadsheet with layout and fonts preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx for comprehensive guidelines.
PDF To XML

Convert PDF to XML with information about text value, tables, fonts, images, objects positions. Please see api documentation at https://developer.pdf.co/api/pdf-to-xml/index.html for comprehensive guidelines.
Rotate PDF Pages

Rotate PDF Pages. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html for comprehensive guidelines.
Rotate PDF Pages (Auto)

Uses AI to automatically fix the rotation of pages inside scanned PDF based on text analysis. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto for comprehensive guidelines.
Send Email with Attachments

Send Email with Attachments. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html for comprehensive guidelines.
Split PDF

Splits pages from PDF document into multiple new PDF files using page numbers and page ranges. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html for comprehensive guidelines.
Split PDF (Advanced)

Split PDF into multiple PDF files by text search (support regular expressions) or barcode. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 for comprehensive guidelines.
Spreadsheet to CSV

Convert XLS/XLSX into CSV comma separated values file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv for comprehensive guidelines.
Spreadsheet to HTML

Convert XLS/XLSX into HTML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html for comprehensive guidelines.
Spreadsheet to JSON

Convert XLS/XLSX into JSON file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json for comprehensive guidelines.
Spreadsheet to TXT

Convert XLS/XLSX or CSV into Text file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt for comprehensive guidelines.
Spreadsheet to XML

Convert XLS/XLSX or CSV into XML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml for comprehensive guidelines.
URL to PDF

Create PDF from URL. Please see api documentation at https://developer.pdf.co/api/pdf-from-url/index.html for comprehensive guidelines.

Add Text, Images, Form Fields to PDF

Operation ID:
PdfFiller

Add text, images, signatures to pdf. Fill PDF form fields and create new pdf from templates. Please see api documentation at https://developer.pdf.co/api/pdf-add/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

Url to the input PDF document
Annotations String
 annotationsString string

Annotation strings to be added to the PDF document. Format should be like “x;y;page;text”. Refer to PDF.co documentations for more advanced formats and examples.
Images String
 imagesString string

Images to be added to the PDF document. Format should be like “x;y;page;urltoimage;link;width;height”. Refer to PDF.co documentations for more advanced formats and examples.
Fields String
 fieldsString string

Fill PDF form fields. Format should be like “page;fieldName;value”. Refer to PDF.co documentations for more advanced formats and examples.
Name
 name string

Output PDF Name
Inline
 inline boolean

Determines whether to return output in response or link to output file.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Page Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status Code
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits

Background Jobs Check

Operation ID:
JobCheck

Checks status of background job that was previously created with PDF.co API. Please see api documentation at https://developer.pdf.co/api/background-job-check/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
Job Id
 jobid True string

PDF.co background Job Id

Returns

Name Path Type Description
Status
 status string

status
Url
 url string

url
Job Id
 jobId string

jobId
Duration
 duration integer

duration

Barcode Generator

Operation ID:
BarcodeGenerator

Generate high quality barcode images. Supports QR Code, Datamatrix, Code 39, Code 128, PDF417 and many other barcode types. Please see api documentation at https://developer.pdf.co/api/barcode-generator/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
Name
 name string

Set async to true for long processes to run in the background, API will then return a jobId which you can use with /job/check endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Value
 value True string

Set the string value to encode inside the barcode.
Type
 type True string

Set the barcode type, QRCode By default.
Decoration Image
 decorationImage string

Set this to the image that you want to be inserted the logo inside the QR-Code barcode.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck Module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co Knowledgebase https://developer.pdf.co/api/profiles/index.html for profile examples

Returns

Name Path Type Description
JobId
 jobId string

jobId
URL
 url string

url
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Barcode Reader

Operation ID:
BarcodeReader

Read barcodes from images and PDF. Can read all popular barcode types from QR Code and Code 128, EAN to Datamatrix, PDF417, GS1 and many other barcodes. Please see api documentation at https://developer.pdf.co/api/barcode-reader/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Types
 types True string

Set the barcode type, QRCode is default. You can also combine types by comma, example "QRCode,Code128,Code39,Interleaved2of5,EAN13". All supported barcode types are AustralianPostCode, Aztec, BorderedTable, Checkbox, Circle, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, DPMDataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, HorizontalLine, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, Oval, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, Rectangle, RoyalMail, RoyalMailKIX, Segment, Trioptic, UnderlinedField, UPCA, UPCE, UPU, VerticalLine.
Pages
 pages string

Comma-Separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the end of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means the first page, then the 3rd page to the 6th page, and then the range from the 8th (index = 7) page till the end of the document.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
JobId
 jobId string

jobId
URL
 url string

url
barcodes
 barcodes array of object

barcodes
Value
 barcodes.Value string

Value
Type
 barcodes.Type integer

Type
Rect
 barcodes.Rect string

Rect
Page
 barcodes.Page integer

Page
File
 barcodes.File string

File
Confidence
 barcodes.Confidence float

Confidence
Metadata
 barcodes.Metadata string

Metadata
TypeName
 barcodes.TypeName string

TypeName
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Document Classifier

Operation ID:
PDFClassifier

Auto classification Of Incoming Documents based on keywords-based rules. For example, you can define rules to find which vendor provided the document to find which template to apply accordingly. Please see api documentation at https://developer.pdf.co/api/document-classifier/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Rules (in CSV format)
 rulescsv string

Define custom classification rules in CSV format. Rules are in CSV format where each row contains: "class name, logic (AND or OR (default)), and keywords" separated by a comma. Each row is separated by the \n symbol.
Rules URL (in CSV format)
 rulescsvurl string

Instead of inline CSV you can use this parameter and set the URL to a CSV file with classification rules. This is useful if you have a separate developer working on CSV rules.
Case Sensitive
 caseSensitive boolean

Defines if keywords in rules are case-sensitive or not.
Inline
 inline boolean

Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Password
 password string

Password of the PDF file
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
classes
 body.classes array of object
Class
 body.classes.class string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Document Parser

Operation ID:
DocumentParser

Document Parser can automatically parse PDF, JPG, and PNG documents to extract fields, tables, values, and barcodes from invoices, statements, orders, and other PDF and scanned documents. Please see api documentation at https://developer.pdf.co/api/document-parser/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. To upload files via API, Check out the Files Upload section at https://developer.pdf.co/api/file-upload/index.html
Template Id
 templateId string

Set ID of document parser template to be used. View and manage your templates at https://app.pdf.co/document-parser
Output Format
 outputFormat True string

Default is JSON. You can override the default output format to CSV or XML to generate CSV or XML output accordingly.
Inline
 inline boolean

Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated
Password
 password string

Password of PDF file
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase https://developer.pdf.co/api/profiles/index.html for profile examples,
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with "Job Check" to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

Output URL
objects
 body.objects array of object

tables
name
 body.objects.name string

name
objectType
 body.objects.objectType string

type of object
value
 body.objects.value string

value
pageIndex
 body.objects.pageIndex integer

pageIndex
rectangle
 body.objects.rectangle array of float

rectangle
rows
 body.objects.rows array of object

rows
items
 body.objects.rows object
Page Count
 pageCount integer
Job Id
 jobId string
Status
 status integer
Name
 name string
Remaining Credits
 remainingCredits integer
Message
 message string

Email Attachment Extraction

Operation ID:
EmailAttachmentExtraction

Extract Email attachments with basic email information. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
From
 body.from string
Subject
 body.subject string
Body (HTML)
 body.bodyHtml string
Body (Text)
 body.bodyText string
attachments
 body.attachments array of object
File Name
 body.attachments.filename string
contentid
 body.attachments.contentid string

Content Id
url
 body.attachments.url string

URL
filesizeinbytes
 body.attachments.filesizeinbytes integer

File Size (in bytes)
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Email Information

Operation ID:
EmailDecode

Get Email Information such as sender/recipient, subject, body, etc. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
From
 body.from string
From Name
 body.fromName string
to
 body.to array of object
Address
 body.to.address string
Name
 body.to.Name string

Name
cc
 body.cc array of object
Address
 body.cc.address string
Name
 body.cc.Name string

Name
bcc
 body.bcc array of object
Address
 body.bcc.address string
Name
 body.bcc.Name string

Name
Sent At
 body.sentAt string
Received At
 body.receivedAt string
Subject
 body.subject string
Body (HTML)
 body.bodyHtml string
Body (Text)
 body.bodyText string
Attachment Count
 body.attachmentCount integer
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

HTML to PDF

Operation ID:
HtmlToPdf

Convert HTML code snippet into full featured PDF. Please see api documentation at https://developer.pdf.co/api/pdf-to-html/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
HTML
 html True html

Input HTML code to be converted.
Name
 name string

Base file name for new PDF files.
margins
 margins string

Override default margins with custom values (the order is top right bottom left). You can als set all margins: 10px, 5mm, 5in for all sides.
Paper Size
 paperSize string

Select PDF paper size. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in.
Orientation
 orientation string

PDF page orientation.
Print Background
 printBackground boolean

Enable or disable printing of document background
Header
 header html

Set to HTML for header to be applied on every page at the header.
Footer
 footer html

Set to HTML for footer to be applied on every page at the bottom.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Page Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status Code
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits

Make Scanned PDF to Text Searchable

Operation ID:
PDFSearchable

Turn PDF and scanned JPG, PNG images into text-searchable PDF. Please see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Password
 password string

Password of PDF file
Async
 async boolean

Set Async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Merge PDF

Operation ID:
MergePdfSimplified

Merge PDF from two or more PDF files into a new one. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

The comma-separated list of links to PDFs files. Supports links to external sites, filetoken://.. from PDF.co Files storage and links to G Drive, Dropbox and other services. Links should be accessible without password. For password protected PDF files, use PDF Security module first to unlock input pdf.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Page Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status Code
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits

Merge PDF (Advanced)

Operation ID:
MergePdf

Merge PDF from two or more pdf, doc, xls, images, even zip with documents and images into a new PDF. Supports zip, doc, docx, xls, xlsx, rtf, txt, png, jpg. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

The comma-separated list of links to PDFs, documents, spreadsheets, images. Supports links to external sites, filetoken://.. from PDF.co Files storage and links to G Drive, Dropbox and other services. Links should be accessible without password. For password protected PDF files, use PDF Security module first to unlock input pdf.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Page Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status Code
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits

PDF Add Security

Operation ID:
PDFAddSecurity

Add password and security limitations to existing PDF. Please see api documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Owner Password
 ownerPassword True string

The main owner password that is used for document encryption and for setting/removing restrictions.
User Password
 userPassword string

The optional user password will be asked for viewing and printing document.
Encryption Algorithm
 encryptionAlgorithm string

Encryption algorithm. Valid values: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit. AES_128bit or higher is recommended
Allow Accessibility Support
 allowAccessibilitySupport boolean

Allow or prohibit content extraction for accessibility needs. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Allow Assembly Document
 allowAssemblyDocument boolean

Allow or prohibit assembling the document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Allow Print Document
 allowPrintDocument boolean

Allow or prohibit printing PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Allow Fill Forms
 allowFillForms boolean

Allow or prohibit the filling of interactive form fields (including signature fields) in the PDF documents. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Allow Modify Document
 allowModifyDocument boolean

Allow or prohibit modification of PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Allow Content Extraction
 allowContentExtraction boolean

Allow or prohibit copying content from PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Allow Modify Annotations
 allowModifyAnnotations boolean

Allow or prohibit interacting with text annotations and forms in PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Print Quality
 printQuality string

Allowed printing quality. Valid values: HighResolution, LowResolution. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Attachment Extraction

Operation ID:
PDFAttachmentExtraction

Extract attachments from input PDF document. Please see api documentation at https://developer.pdf.co/api/extract-attachments/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

Url to the source PDF document
Inline
 inline boolean

Determines whether to return output in response or link to output file.
Name
 name string

Base file name for new PDF files
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Creates a background processing job.

Returns

Name Path Type Description
urls
 urls array of string

urls
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits

PDF Compress and Optimize

Operation ID:
PDFCompress

Optimize PDF document to reduce its size. Please see api documentation at https://developer.pdf.co/api/pdf-optimize/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Name
 name string

File name for the generated output
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Password
 password string

Password of the PDF file
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Delete Pages

Operation ID:
PDFDeletePages

Delete pages in PDF. Please see api documentation at https://developer.pdf.co/api/pdf-delete-pages/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Name
 name string

File name for the generated output
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Find Table

Operation ID:
PDFFindTable

AI powered document analysis can scan your document for tables and return the array of tables on pages with coordinates and information about columns detected in these tables. Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Inline
 inline boolean
Password
 password string

Password of PDF file
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with /job/check endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
Job Id
 jobId string

jobId
URL
 url string

url
tables
 body.tables array of object

tables
PageIndex
 body.tables.PageIndex integer

PageIndex
body.tables.X float

X
Y
 body.tables.Y float

Y
Width
 body.tables.Width float

Width
body.tables.Height float

Height
Columns
 body.tables.Columns array of float

Columns
Rectangle
 body.tables.rect string

rect
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

Credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Forms Info Reader

Operation ID:
PDFFormsInfoReader

Get information about fillable fields inside PDF form file. Please see api documentation at https://developer.pdf.co/api/pdf-forms-info-reader/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Password
 password string

Password of the PDF file
Profiles
 profiles string

Use this parameter to set additional configuration for fine-tuning and extra options, Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
JobId
 jobId string

jobId
URL
 url string

url
PageCount
 info.PageCount integer

PageCount
Author
 info.Author string

Author
Title
 info.Title string

Title
Producer
 info.Producer string

Producer
Subject
 info.Subject string

Subject
CreationDate
 info.CreationDate string

CreationDate
Bookmarks
 info.Bookmarks string

Bookmarks
Keywords
 info.Keywords string

Keywords
Creator
 info.Creator string

Creator
Encrypted
 info.Encrypted boolean

Encrypted
PasswordProtected
 info.PasswordProtected boolean

PasswordProtected
IsEmpty
 info.PageRectangle.Location.IsEmpty boolean

IsEmpty
X
 info.PageRectangle.Location.X float

X
Y
 info.PageRectangle.Location.Y float

Y
Size
 info.PageRectangle.Size string

Size
X
 info.PageRectangle.X float

X
Y
 info.PageRectangle.Y float

Y
Width
 info.PageRectangle.Width float

Width
info.PageRectangle.Height float

Height
info.PageRectangle.Left float

Left
Top
 info.PageRectangle.Top float

Top
Right
 info.PageRectangle.Right float

Right
info.PageRectangle.Bottom float

Bottom
IsEmpty
 info.PageRectangle.IsEmpty boolean

IsEmpty
ModificationDate
 info.ModificationDate string

ModificationDate
Attachment Count
 info.AttachmentCount integer

AttachmentCount
EncryptionAlgorithm
 info.EncryptionAlgorithm string

EncryptionAlgorithm
PermissionPrinting
 info.PermissionPrinting boolean

PermissionPrinting
PermissionModifyDocument
 info.PermissionModifyDocument boolean

PermissionModifyDocument
PermissionContentExtraction
 info.PermissionContentExtraction boolean

PermissionContentExtraction
PermissionModifyAnnotations
 info.PermissionModifyAnnotations boolean

PermissionModifyAnnotations
PermissionFillForms
 info.PermissionFillForms boolean

PermissionFillForms
PermissionAccessibility
 info.PermissionAccessibility boolean

PermissionAccessibility
PermissionAssemble
 info.PermissionAssemble boolean

PermissionAssemble
PermissionHighQualityPrint
 info.PermissionHighQualityPrint boolean

PermissionHighQualityPrint
CustomProperties
 info.CustomProperties array of object

CustomProperties
Key
 info.CustomProperties.Key string

Key
Value
 info.CustomProperties.Value string

Value
Fields
 info.FieldsInfo.Fields array of object

Fields
PageIndex
 info.FieldsInfo.Fields.PageIndex integer

PageIndex
Type
 info.FieldsInfo.Fields.Type string

Type
FieldName
 info.FieldsInfo.Fields.FieldName string

FieldName
AltFieldName
 info.FieldsInfo.Fields.AltFieldName string

AltFieldName
Value
 info.FieldsInfo.Fields.Value string

Value
Left
 info.FieldsInfo.Fields.Left float

Left
Top
 info.FieldsInfo.Fields.Top float

Top
Width
 info.FieldsInfo.Fields.Width float

Width
Height
 info.FieldsInfo.Fields.Height float

Height
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF from CSV

Operation ID:
PDFFromCSV

Convert CSV document to PDF. Works also with XLS or XLSX input. Please see api documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF from Document (Doc, DocX, RTF, TXT, XPS)

Operation ID:
PDFFromDoc

Convert DOC, DOCX, RTF, TXT, XPS files into PDF. Please see api documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF from Email

Operation ID:
PDFFromEmail

Convert email files (MSG or EML) code into PDF. Extracts attachments (if any) from input email and embeds into PDF as pdf attachments. Please see api documentation at https://developer.pdf.co/api/pdf-from-email/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Embed Attachments
 embedAttachments boolean

Set to true to automatically embeds all attachments from original input email MSG or EML files into the final output PDF. Set it to false if you don’t want to embed attachments so it will convert only the body of the input email.
Convert Attachments
 convertAttachments boolean

Set to false if you don’t want to convert attachments from the original email and want to embed them as original files (as embedded pdf attachments). Converts attachments that are supported by API (DOC, DOCx, HTML, PNG, JPG .etc) into PDF and merges into output final PDF. Non-supported file types are added as PDF attachments (Adobe Reader or another viewer may be required to view PDF attachments).
Margins
 margins string

set to CSS style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left).
Paper Size
 paperSize string

Letter is set by default. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in.
Orientation
 orientation string
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF from Image

Operation ID:
PDFFromImages

Create a PDF file from one or more JPG, PNG, TIFF images. Please see api documentation at https://developer.pdf.co/api/pdf-from-image/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URLs
 url True string

URL to the source file. Provide multiple URLS in comma seperated format. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF From Spreadsheet

Operation ID:
PDFFromXLSXLSX

Create PDF from XLS, XLSX spreadsheet. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Worksheet Index
 worksheetIndex string

Set the WorkSheet index (Default is 0).
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Info Reader

Operation ID:
PDFInfoReader

Get detailed information about the PDF document, it's properties and security permissions. Please see api documentation at https://developer.pdf.co/api/pdf-info-reader/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Password
 password string

Password of the PDF file
Profiles
 profiles string

Use this parameter to set additional configuration for fine-tuning and extra options, Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
JobId
 jobId string

jobId
URL
 url string

url
PageCount
 info.PageCount integer

PageCount
Author
 info.Author string

Author
Title
 info.Title string

Title
Producer
 info.Producer string

Producer
Subject
 info.Subject string

Subject
CreationDate
 info.CreationDate string

CreationDate
Bookmarks
 info.Bookmarks string

Bookmarks
Keywords
 info.Keywords string

Keywords
Creator
 info.Creator string

Creator
Encrypted
 info.Encrypted boolean

Encrypted
PasswordProtected
 info.PasswordProtected boolean

PasswordProtected
IsEmpty
 info.PageRectangle.Location.IsEmpty boolean

IsEmpty
info.PageRectangle.Location.X float

X
info.PageRectangle.Location.Y float

Y
Size
 info.PageRectangle.Size string

Size
info.PageRectangle.X float

X
info.PageRectangle.Y float

Y
info.PageRectangle.Width float

Width
info.PageRectangle.Height float

Height
info.PageRectangle.Left float

Left
info.PageRectangle.Top float

Top
info.PageRectangle.Right float

Right
info.PageRectangle.Bottom float

Bottom
IsEmpty
 info.PageRectangle.IsEmpty boolean

IsEmpty
ModificationDate
 info.ModificationDate string

ModificationDate
AttachmentCount
 info.AttachmentCount integer

AttachmentCount
EncryptionAlgorithm
 info.EncryptionAlgorithm string

EncryptionAlgorithm
PermissionPrinting
 info.PermissionPrinting boolean

PermissionPrinting
PermissionModifyDocument
 info.PermissionModifyDocument boolean

PermissionModifyDocument
PermissionContentExtraction
 info.PermissionContentExtraction boolean

PermissionContentExtraction
PermissionModifyAnnotations
 info.PermissionModifyAnnotations boolean

PermissionModifyAnnotations
PermissionFillForms
 info.PermissionFillForms boolean

PermissionFillForms
PermissionAccessibility
 info.PermissionAccessibility boolean

PermissionAccessibility
PermissionAssemble
 info.PermissionAssemble boolean

PermissionAssemble
PermissionHighQualityPrint
 info.PermissionHighQualityPrint boolean

PermissionHighQualityPrint
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Remove Security

Operation ID:
PDFSecurityRemove

Remove password and security from existing PDF files. Please see api documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Password
 password True string

The owner/user password to open files and remove security features.
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Search and Delete Text from PDF

Operation ID:
SearchAndDeleteText

Search text in PDF and remove found text from PDF. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-delete-text/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
searchStrings
 searchStrings True array of string

searchStrings
Is Case Sensitive
 caseSensitive boolean
Is Regex Enabled?
 regex boolean

Set to true to use regular expression for a search string(s).
Replacement Limit
 replacementLimit integer

Limit the number of searches & replacements for every item. The default value is 0 which means unlimited searches and replacements so every found occurrence will be replaced.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Name
 name string

File name for the generated output
Password
 password string

Password of the PDF file
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Search and Replace Text

Operation ID:
SearchAndReplace

Modify a PDF file by searching for specific text and replacing it with new text. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
searchStrings
 searchStrings True array of string

Search Strings
replaceStrings
 replaceStrings array of string

Replacement Strings
Is Case Sensitive?
 caseSensitive boolean
Replacement Limit
 replacementLimit integer

Limit the number of searches & replacements for every item. The default value is 0 which means unlimited searches and replacements so every found occurrence will be replaced.
Is Regex Enabled?
 regex boolean

Set to true to use regular expression for a search string(s).
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Password
 password string

The password of the PDF file
Name
 name string

File name for the generated output
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
Page Count
 pageCount integer
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

PDF Search and Replace Text with Image

Operation ID:
SearchAndReplaceWithImage

Replace specific text in a PDF document with an image. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Is Case Sensitive
 caseSensitive boolean
Search String
 searchString True string

Single text replacement. Word or phrase to be replaced
Replace Image URL
 replaceImage True string

Image URL to be inserted in the doc.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Is Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with Job Check module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish..
Is Regex Enabled?
 regex boolean
Replacement Limit
 replacementLimit integer

Limit the number of searches & replacements for every item. The default value is 0 which means unlimited searches and replacements so every found occurrence will be replaced.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Password
 password string

Password of the PDF file

Returns

Name Path Type Description
Job Id
 jobId string

jobId
URL
 url string

url
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF Search Text

Operation ID:
PDFSerarchText

Search text in PDF and get coordinates. Supports regular expressions. Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Search String
 searchString True string

Text to search can support regular expressions if you set the "Regex Search" parameter to true.
Is Regex Search
 regexSearch boolean
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document) for ALL pages just leave this param empty. Example: 0,2-5,7- means the first page, then the 3rd page to the 6th page, and then the range from the 8th (index = 7) page till the end of the document, The input must be in string format.
Inline
 inline boolean
Word Matching Mode
 wordMatchingMode string

Values can be either ‘SmartMatch’, ‘ExactMatch’, or ‘None’.
Password
 password string

Password of the PDF file
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
body
 body array of object

body
Text
 body.text string

text
Left
 body.left float

left
Top
 body.top float

top
Width
 body.width float

width
Height
 body.height float

height
Page Index
 body.pageIndex integer

pageIndex
URL
 url string

url
Job Id
 jobId string
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To CSV

Operation ID:
PDFToCSV

Convert PDF and scanned images into CSV representation with layout, columns, rows, and tables. Please see api documentation at https://developer.pdf.co/api/pdf-to-csv/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
Inline
 inline boolean
UnWrap
 unwrap string

Unwrap lines into a single line within table cells when lineGrouping is enabled.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Line Grouping
 lineGrouping string

Line grouping within table cells. Set to 1 to enable the grouping.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.

Returns

Name Path Type Description
Body
 body string

body
URL
 url string

url
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF to JPG

Operation ID:
PDFToJPG

PDF to JPG conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
inline
 inline boolean

inline
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
urls
 urls array of string

urls
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To JSON

Operation ID:
PDFToJSON

Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-json/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
Inline
 inline boolean
UnWrap
 unwrap string

Unwrap lines into a single line within table cells when lineGrouping is enabled.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Line Grouping
 lineGrouping string

Line grouping within table cells. Set to 1 to enable the grouping.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.

Returns

Name Path Type Description
Body
 body object

body
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To JSON (AI Powered)

Operation ID:
PDFToJSONMeta

Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
Inline
 inline boolean
UnWrap
 unwrap string

Unwrap lines into a single line within table cells when lineGrouping is enabled.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Line Grouping
 lineGrouping string

Line grouping within table cells. Set to 1 to enable the grouping.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.

Returns

Name Path Type Description
Body
 body object

body
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF to PNG

Operation ID:
PDFToPNG

PDF to PNG conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
inline
 inline boolean

inline
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
urls
 urls array of string

urls
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF to Scanned PDF

Operation ID:
PDFUnSearchable

Convert PDF to Scanned PDF. Result PDF is same as if you printed and then scanned your PDF. Please see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Password
 password string

Password of PDF file
Async
 async boolean

Set Async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To Text (with layout and ocr)

Operation ID:
PDFToText

Convert PDF and scanned images to Text with layout preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
Inline
 inline boolean
UnWrap
 unwrap string

Unwrap lines into a single line within table cells when lineGrouping is enabled.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Line Grouping
 lineGrouping string

Line grouping within table cells. Set to 1 to enable the grouping.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.

Returns

Name Path Type Description
Body
 body string

body
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To Text (without layout and ocr)

Operation ID:
PDFToTextSimple

Convert PDF to plain text without layout preserved and OCR support. Please see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Inline
 inline boolean
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.

Returns

Name Path Type Description
Body
 body string

body
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF to TIFF

Operation ID:
PDFToTIFF

PDF to high quality TIFF images conversion. High quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
inline
 inline boolean

inline
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF to WEBP

Operation ID:
PDFToWEBP

PDF to WEBP conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
inline
 inline boolean

inline
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
urls
 urls array of string

urls
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To XLS

Operation ID:
PDFToXLS

Convert PDF and scanned images to spreadsheet with layout and fonts preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
UnWrap
 unwrap string

Unwrap lines into a single line within table cells when lineGrouping is enabled.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Line Grouping
 lineGrouping string

Line grouping within table cells. Set to 1 to enable the grouping.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To XLSX

Operation ID:
PDFToXLSX

Convert PDF and scanned images to spreadsheet with layout and fonts preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
UnWrap
 unwrap string

Unwrap lines into a single line within table cells when lineGrouping is enabled.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Line Grouping
 lineGrouping string

Line grouping within table cells. Set to 1 to enable the grouping.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

PDF To XML

Operation ID:
PDFToXML

Convert PDF to XML with information about text value, tables, fonts, images, objects positions. Please see api documentation at https://developer.pdf.co/api/pdf-to-xml/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Inline
 inline boolean
OCR Language
 lang string

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
UnWrap
 unwrap string

Unwrap lines into a single line within table cells when lineGrouping is enabled.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Rectangle
 rect string

Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Name
 name string

File name for the generated output
Line Grouping
 lineGrouping string

Line grouping within table cells. Set to 1 to enable the grouping.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.

Returns

Name Path Type Description
URL
 url string

url
Body
 body string

body
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Rotate PDF Pages

Operation ID:
PDFRotatePages

Rotate PDF Pages. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Angle
 angle integer

Angle in degrees. Supported values 90, 180, and 270.
Pages
 pages string

Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Password
 password string

Password of the PDF file
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Rotate PDF Pages (Auto)

Operation ID:
PDFAutoRotatePages

Uses AI to automatically fix the rotation of pages inside scanned PDF based on text analysis. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
OCR Language
 lang string

the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Password
 password string

Password of the PDF file
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Page Count
 pageCount integer

pageCount
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Send Email with Attachments

Operation ID:
EmailSend

Send Email with Attachments. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
From
 from True string

The “From” field with sender name and email. Example: John Doe john@example.com
To
 to True string

The “To” field with receiver name and email. Example: Partner partner@example.com
Subject
 subject True string

The subject for the outgoing email
Body (in Text format)
 bodytext string

Plain text version of the outgoing email message.
Body (in HTML format)
 bodyhtml string

HTML version of the outgoing email message.
SMTP Server
 smtpserver True string

SMTP server address
SMTP Port
 smtpport True string

SMTP port
SMTP Username
 smtpusername True string

SMTP server username
SMTP Password
 smtppassword True string

SMTP server password, If you use Gmail then you need to generate an app-specific password as instructed at https://support.google.com/accounts/answer/185833.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Credits
 credits integer

credits
Remaining Credits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Split PDF

Operation ID:
SplitPdf

Splits pages from PDF document into multiple new PDF files using page numbers and page ranges. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

Url to the source PDF document
Pages
 pages True string

Comma-separated list of page indices (or ranges) to split into. First page is 1 (one). Example: "1,2-5,7-". Special cases: to extract each page into separate PDF use to *.
Inline
 inline boolean

Determines whether to return output in response or link to output file.
Name
 name string

Base file name for new PDF files
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Creates a background processing job.

Returns

Name Path Type Description
urls
 urls array of string

urls
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Page Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits

Split PDF (Advanced)

Operation ID:
SplitPdf2

Split PDF into multiple PDF files by text search (support regular expressions) or barcode. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

Url to the source PDF document
Search String
 searchString True string

Text to search for on pages. Can also search by barcode, for more info visit https://developer.pdf.co/api/pdf-split/index.html?utm_source=api-docs#post-tag-pdf-split2
Exclude Key Pages
 excludeKeyPages boolean

Set to true if you want to exclude pages where text was found
regexSearch
 regexSearch boolean

Set to true to enable regular expressions for the search string
caseSensitive
 caseSensitive boolean

Set to true to enable case-sensitive search.
OCR Language
 lang string

the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is “eng”. Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
Inline
 inline boolean

Determines whether to return output in response or link to output file.
Name
 name string

Base file name for new PDF files
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
Async
 async boolean

Creates a background processing job.

Returns

Name Path Type Description
urls
 urls array of string

urls
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Page Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits

Spreadsheet to CSV

Operation ID:
XLStoCSV

Convert XLS/XLSX into CSV comma separated values file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Worksheet Index
 worksheetIndex string

Set the WorkSheet index (Default is 0).
Quotation Symbol
 quotationSymbol string

Set the CSV Quotation Symbol
Separator Symbol
 separatorSymbol string

Set the CSV Separator Symbol
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Spreadsheet to HTML

Operation ID:
XLStoHTML

Convert XLS/XLSX into HTML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Worksheet Index
 worksheetIndex string

Set the WorkSheet index (Default is 0).
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Spreadsheet to JSON

Operation ID:
XLStoJSON

Convert XLS/XLSX into JSON file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Worksheet Index
 worksheetIndex string

Set the WorkSheet index (Default is 0).
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Spreadsheet to TXT

Operation ID:
XLStoTXT

Convert XLS/XLSX or CSV into Text file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Worksheet Index
 worksheetIndex string

Set the WorkSheet index (Default is 0).
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

Spreadsheet to XML

Operation ID:
XLStoXML

Convert XLS/XLSX or CSV into XML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
Worksheet Index
 worksheetIndex string

Set the WorkSheet index (Default is 0).
Name
 name string

File name for the generated output.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
Profiles
 profiles string

You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.

Returns

Name Path Type Description
URL
 url string

url
Job Id
 jobId string

jobId
Error
 error boolean

error
Status
 status integer

status
Name
 name string

name
Credits
 credits integer

credits
remainingCredits
 remainingCredits integer

remainingCredits
Duration
 duration integer

duration

URL to PDF

Operation ID:
UrlToPdf

Create PDF from URL. Please see api documentation at https://developer.pdf.co/api/pdf-from-url/index.html for comprehensive guidelines.

Parameters

Name Key Required Type Description
URL
 url True string

Link to input HTML file or website page to be converted. You can pass link to file from Google Drive, Dropbox or another online file service that can generate shareable links.
Margins
 margins string

Margins to be used in output document. Set to css style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left).
Paper Size
 paperSize string

Letter is set by default. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in.
Orientation
 orientation string

Output page orientation
Print Background
 printBackground boolean

Enable or disable printing of document background
Header
 header html

Set to HTML for header to be applied on every page at the header.
Footer
 footer html

Set to HTML for footer to be applied on every page at the bottom.
Expiration
 expiration integer

Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
Profiles
 profiles string

This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
Async
 async boolean

Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.

Returns

Name Path Type Description
URL
 url string

Output document URL.
Job Id
 jobId string

jobId
Page Count
 pageCount integer

Number of pages in the output document.
Error
 error boolean

Indicates whether the operation is successful or not.
Status Code
 status integer

Status code for HTTP response
Name
 name string

Output document name
Credits
 credits integer

PDF.co credits used for this request
Duration
 duration integer

Request execution duration
Remaining Credits
 remainingCredits integer

PDF.co account remaining credits