PDF.co API icon

PDF.co API

Generate PDF, extract data from PDF, split PDF, merge PDF, convert PDF. Fill PDF forms, add text and images to pdf and much more with pdf.co!

Actions19

Search in PDF

AI-generated

Overview

This node allows users to search for specific text within a PDF document accessible via a URL. It supports searching with plain text or regular expressions, specifying pages or page ranges to search, and advanced options like password protection, HTTP authentication, and custom processing profiles. This is useful for extracting information such as company names or keywords from PDFs automatically.

Use Case Examples

  1. Search for a company name in a PDF report hosted online.
  2. Use regular expressions to find complex patterns in a multi-page PDF document.
  3. Search specific pages or ranges within a PDF to limit the scope of the search.

Properties

Name Meaning
Authentication Method to authenticate API requests, either via API Key or OAuth2.
PDF URL The URL of the PDF file to search within.
Search Query The text or pattern to search for inside the PDF.
Use Regular Expressions Whether to interpret the search query as a regular expression for complex pattern matching.
Pages Pages or page ranges to search within the PDF, supporting ranges and negative indexing.
Advanced Options Additional optional parameters such as output file name, callback URL, link expiration, inline response, word matching mode, PDF password, HTTP authentication, and custom processing profiles.

Output

JSON

  • searchResults - Array of search result objects containing matched text and metadata.
  • fileName - Name of the output file if specified.
  • outputLinks - Links to the output data if returned asynchronously or stored externally.

Dependencies

  • Requires API authentication via API Key or OAuth2 to access the PDF.co service.

Troubleshooting

  • Ensure the PDF URL is accessible and correct; HTTP authentication credentials must be provided if required.
  • Verify the search query syntax, especially if using regular expressions, to avoid errors.
  • Check that the specified pages or page ranges are valid within the PDF document.
  • If using password-protected PDFs, ensure the correct password is provided.
  • If output is not returned inline, verify the callback URL is correctly set up to receive data.

Links

Discussion