PDF.co

The PDF.co modules allow you to convert documents, and images into PDF and vice-versa from your PDF.co account.

Getting Started with PDF.co

Prerequisites

Note

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

Connecting PDF.co to Make

To connect your PDF.co account to Make you need to obtain the API Key from your PDF.co account and insert it in the Create a connection dialog in the Make module.

  1. Log in to your PDF.co account.

  2. Click Your API Key and copy the API key to your clipboard.

    61f274d7be735.gif
  3. Go to Make and open the PDF.co module's Create a connection dialog.

    61f274dc0d866.gif
  4. In the Connection name field, enter a name for the connection.

  5. In the Your PDF.co API Key. Sign up at www.PDF.co to get one field, enter the API key copied in step 2, and click Continue.

The connection has been established.

Conversion from PDF

Convert PDF pages to structured CSV, XML, JSON, Plain Text, and other formats.

Connection

Establish a connection to your PDF.co account.

Import Options

Input File

Select or map the option to provide the PDF file details:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Convert Options

Select or map the convert type you want to apply to the PDF. For example, PDF to CSV.

Pages

Enter a Comma-separated list of page indices (or ranges) to process the PDF. Leave the field blank to process all the pages. The first page is 0 (zero). For example, '0,1-2,5-'.

Password

Enter (map) the password for the PDF you want to convert.

Inline

Select whether you want the output as a string.

Please Note: Do not enable the inline if you need to download the output file.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for the PDF:

  • Download a file

  • JSON Output

Convert PDF to JPG or PNG for every selected pdf page or page range.

Connection

Establish a connection to your PDF.co account.

Import Options

Input File

Select or map the option to provide the PDF file details:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Convert Options

Select or map the convert type you want to apply to the PDF. For example, PDF to CSV.

Pages

Enter a comma-separated list of page indices (or ranges) to process the PDF into images. Leave the field blank to process all the pages. The first page is 0 (zero). For example, '0,1-2,5-'.

Password

Enter (map) the password for the PDF you want to convert.

Inline

Select whether you want the output as a string.

Please Note: Do not enable the inline if you need to download the output file.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for the PDF:

  • Download a file

  • JSON Output

Conversion into PDF

Convert documents, spreadsheets, presentations, emails, single images to PDF.

Connection

Establish a connection to your PDF.co account.

Import Options

Input File

Select or map the option to provide the PDF file details:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Convert Options

Select or map the convert type. For example, Email to PDF.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for the PDF:

  • Download a file

  • JSON Output

Creates PDF from one or more JPEG, PNG, or TIFF images.

Connection

Establish a connection to your PDF.co account.

Import Options

Input Type

Select or map the option to provide the PDF file details:

  • Upload Files

  • Input Link

Data

Select or map the file data.

Input Link

Select or map the URL address link to the input file or multiple links separated by a comma.

File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for the PDF:

  • Download a file

  • JSON Output

Convert HTML code or URL to PDF.

Connection

Establish a connection to your PDF.co account.

Convert Options

Select or map the convert type.

  • HTML to PDF

  • URL to PDF

Input HTML Code

Enter (map) the HTML code which you want to convert to PDF.

Input URL to web page

Enter (map) the URL address of the webpage which you want to convert to PDF.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Orientation

Select or map the orientation of the PDF:

  • Portrait

  • Landscape

Paper Size

Select or map the PDF paper size. For example, Letter.

Print Background

Select whether you want to enable the PDF background printing.

Do not wait for a full load

Select whether you want to enable the waiting for a full load. This helps speed up the pages with dynamic content.

Margins

Enter (map) the overrides margins CSS styles for the converted PDF page. For example, '10px' , '5mm', '5in' for all sides or '5px 5px 5px 5px'. The order of margins values is top, right, bottom, left.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for the PDF:

  • Download a file

  • JSON Output

PDF

Merges multiple PDF files into one PDF. Also supports doc, docx, rtf, txt, xls, xlsx, csv, jpg, png, and zip as input in Advanced mode.

Connection

Establish a connection to your PDF.co account.

Enable non-PDF files as input

Select whether you want to enable the support for doc, docx, rtf, xls, xlsx, txt, jpg, png, and zip files as input. Uses /pdf/merge2 endpoint that consumes more credits. See the PDF.co credits table for info.

Import Options

Input Type

Select or map the option to provide the PDF file details:

  • Upload Files

  • Input Link

Data

Select or map the file data.

Input Link

Select or map the URL address link to the input file or multiple links separated by a comma.

File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for merged PDF:

  • Download a file

  • JSON Output

PDF splitter that takes a PDF file and splits given pages or page ranges into multiple PDF files.

Connection

Establish a connection to your PDF.co account.

Import Options

Input Type

Select or map the option to provide the PDF file details:

  • Upload Files

  • Input Link

Data

Select or map the file data.

Input Link

Select or map the URL address link to the input file or multiple links separated by a comma.

File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Split

Select or map the option to split the PDF:

  • Text Found

  • Page Numbers

Text Found

Search String

Enter (map) the text you want to search.

Exclude Key Pages

Select whether you want to exclude the key pages.

Regex Search

Select whether you want to enable the Regex search.

Case Sensitive

Select whether the text is case-sensitive.

Language

Select or map the language of the text.

Pages

Enter (map) comma-separated indices of pages (or ranges) that you want to split from the document.The first-page indice is always 1.

For example, if you have a 7-page document that you want to be split into 3 separate PDFs but different numbers of pages it would go like this: 1, 2, 3- or 1, 2, 3-7 which will result in 1 PDF with page one, 1 PDF with page two and one PDF with the rest of the pages.

You can also use inverted page numbers adding ! before the number.- !1 : the last page ,- 2-!2: from the second to the penultimate page,- !2- : last two pages.

Also, you can use a single asterisk( * ) character as the range to split the document into separate pages.

SPECIAL CASES: You can use a single asterisk( * ) symbol to split the document into separate pages.The parameter must be a string.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for merged PDF:

  • Download a file

  • JSON Output

Adds text and images to a PDF document.

Connection

Establish a connection to your PDF.co account.

Import Portions

Input File

Select or map the option to provide the PDF file details:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Text Annotations

Add the text annotation you want to add to the PDF:

Text

Enter (map) the text you want to add.

Pages

Enter (map) the pages to which you want to add the text. Pages start at 0 (zero) and you can set multiple pages as comma-separated ranges like 0,1-2,5,7- where 7- means pages from 7th to the last one. Use negative pages like -2 to set the second page from the last page.

X

Enter (map) the X coordinates for the text object to add in the PDF. To get X and Y coordinates for objects in PDF, please see here to open PDF.co Simple PDF Viewer.

Y

Enter (map) the Y coordinates for the text object to add in the PDF. To get X and Y coordinates for objects in PDF, please see here to open PDF.co Simple PDF Viewer.

Font Size

Enter (map) the text font size.

Font Name

Enter (map) the font name.

Font Color

Enter (map) the color code for the text. For example, CCBBAA.

Font Italic

Select whether you want the font to be italic.

Font Bold

Select whether you want to make the text bold.

Font Strikeout

Select whether you want to strike out the text.

Font Underline

Select whether you want to underline the text.

Link

Select whether you want to enable the link to open with a click.

Images

Add the properties of the image:

URL to the source image

Enter (map) the URL address to image or link to an image stored at PDF.co Files storage.

Pages or pages range

Enter (map) the pages to which you want to add the text. Pages start at 0 (zero) and you can set multiple pages as comma-separated ranges like 0,1-2,5,7- where 7- means pages from 7th to the last one. Use negative pages like -2 to set the second page from the last page.

X

Enter (map) the X coordinates for the image object to add in the PDF. To get X and Y coordinates for objects in PDF, please see here to open PDF.co Simple PDF Viewer.

Y

Enter (map) the X coordinates for the image object to add in the PDF. To get X and Y coordinates for objects in PDF, please see here to open PDF.co Simple PDF Viewer.

Width

Enter (map) the width for the image. You can leave this field empty to automatically detect.

Height

Enter (map) the height for the image. You can leave this field empty to automatically detect.

Link

Select whether you want to enable the link to open with a click.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for merged PDF:

  • Download a file

  • JSON Output

Gets PDF document information such as the number of pages, author, keyword, and others.

Connection

Establish a connection to your PDF.co account.

Import Portions

Input File

Select or map the option to provide the PDF file details whose details you want to retrieve:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

User pre-built extraction templates to automatically read invoices, reports, orders, statements, and other documents with fields and tables.

Connection

Establish a connection to your PDF.co account.

Import Portions

Input File

Select or map the option to provide the PDF file details whose details you want to retrieve:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Document Parser Template ID

Set to 1or leave empty for built-in Invoice Parser template or set to the ID of your template.You can manage your Document Parser templates at https://app.pdf.co/document-parser.

Output Format

Select or map the output format of the document:

  • CSV

  • JSON

  • XML

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. Please see the database for supported custom configurations.

Export Options

Select or map the export type for merged PDF:

  • Download a file

  • JSON Output

Barcode

Generates high-quality printable and scannable barcodes as images or PDF. Supports QR Code, Code 39, Code 128, Datamatrix, PDF417, UPC, EAN, and many others.

Connection

Establish a connection to your PDF.co account.

Barcode Value

Enter (map) the value to be encoded into the barcode. The value must be a string.

Barcode Type

Select or map the barcode type. For example, Code39.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Inline

Set to true to generate URL as inline datauri link that you can embed directly into HTML. Important: you need to switch to JSON as output instead of Download File so it will generate a link with datauri inline data.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. Please see the database for supported custom configurations.

Export Options

Select or map the export type for barcode:

  • Download a file

  • JSON Output

Read barcodes from images, tiff, pdf documents, scanned documents. All popular types of barcodes are supported from Code 39, Code 128 to QR Code, Datamatrix, and PDF417. Supports noisy and damaged barcodes, scans, pdf, documents.

Connection

Establish a connection to your PDF.co account.

Import Options

Input File

Select or map the option to provide the PDF file details whose details you want to retrieve:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Barcode Type

Select or map the barcode type. For example, Code39.

Pages

Enter (map) a comma-separated list of page indices (or ranges) to process. Leave empty for all pages. The first page is 0 (zero). For example, '0,1-2,5-'.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. Please see the database for supported custom configurations.

Other

Uploads a file into temporary storage for use with PDF.co.

Connection

Establish a connection to your PDF.co account.

Source File

Enter (map) the data of the file to be uploaded. The source file is uploaded to secure PDF.co storage and stored for 1 hour. You can use the generated url with other modules and apps within 1 hour.

File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Universal Performs an arbitrary authorized API call.

Connection

Establish a connection to your PDF.co account.

URL

Enter a path relative to https://api.pdf.co For example: /v1/pdf/edit/add

Note

For the list of available endpoints, refer to the PDF.co API Documentation. You can also explore recent API logs on the API Logs page.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Fills a PDF form.

Connection

Establish a connection to your PDF.co account.

Import Options

Input File

Select or map the option to provide the PDF file details:

  • Upload a File

  • Import a File from the URL

Data

Select or map the file data.

URL

Select or map the URL address of the PDF file.

Output File Name

Enter (map) the override file name including the extension for the generated output. The value must be a string.

Fields to Fill

Add the fields to fill in the PDF form:

Page or pages range

Enter (map) the

Field Name

Enter (map) the field name.

Text

Enter the text details to fill in the field. To check a checkbox field, set to true. For radio box, set index as1.

Profiles

Add the optional custom configuration for hidden properties. For example: someoption: 'value' or in JSON format like { 'someoption': 'value'}. See the database for supported custom configurations.

Export Options

Select or map the export type for the PDF:

  • Download a file

  • JSON Output