Parse a Document#

Utilize the PDF.co Document Parser to automatically extract information from various documents such as invoices, reports, orders, and statements. This feature supports both built-in and custom extraction templates, facilitating efficient and accurate data retrieval from fields and tables in documents.

Make Step

Input#

Name

Description

Required

Import Options

Choose the input source, either Upload a File or Import a file from URL.

Yes


Upload a File#

Name

Description

Required

Data

Upload a file using raw binary data from another module. Note: This requires additional credits as it first uploads to PDF.co Temporary Files Storage.

Yes


Import a file from URL#

Name

Description

Required

URL

Provide the URL to the source PDF document, or a filetoken:// link from PDF.co Built-In Files Storage. If you use another cloud service such as Google Drive or Dropbox ensure the link is publicly accessible.

Yes


Name

Description

Required

Document Parser Template ID

Use 1 for the built-in Invoice Parser template or specify custom template IDs. Manage your Document Parser templates at Document Parser Template Editor.

No

Custom Template Code

For on-premise installations, enter the Custom Document Parser Template Code.

No

Output Format

Choose JSON for JSON output, CSV for comma-separated values, or XML.

No

Pages

Enter a comma-separated list of page indices (or ranges) for processing. Leave blank for all pages. The first page is 0 (zero). For example: 0,1-2,5-.

No

Execution Mode

Select Sync for small tasks up to 10 seconds. Choose Async for standard jobs, or Async For Large Docs for tasks over 30 seconds. Use Job Check module for retrieving results in large tasks.

No

Profiles

Add custom options for the process in a JSON string format. See API Profiles for more details.

No

Output Links Expiration

Set the expiration time in minutes for output links. Default is 60 minutes. Increase this limit with a Business Plan or higher, see plans here for details.

No

Export Type

Choose between Download a File or JSON Output. Default is Download a File.

No

Integrating External File Sources#

Note

Streamline your Make workflows with external file sources like Google Drive and Dropbox using their unique actions. Discover efficient integration strategies in our guide: File Source Integrations in Make.


Output#

Name

Description

url

This is the temporary URL provided by the PDF.co file server.

Body

Delivers a parsed object array with results formatted as Name, Value, and Object Type.

Data

Represents the output binary data. This data is generated only when the Export Type option is set to Download a File.

Status

Indicates the response status code. A success status is returned if the operation is successful.

outputLinkValidTill

Specifies the timestamp until which the url remains accessible.

error

Provides details about any errors encountered during the process, if applicable.

Name

The designated name of the output file.

Job Id

A unique identifier assigned to the job.

credits

The amount of credits utilized for the process.

Remaining Credits

Displays the balance of credits available in your account.

duration

The duration of time the process took to complete.