Input

NameDescriptionRequired
PDF Source LinkProvide 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
Search QuerySpecify the text you want to search for within the PDF document.Yes
Enable Regular ExpressionsActivate this option to use regular expressions for more complex search patterns. Example: [0-9]{3}-[0-9]{2}-[0-9]{4} to locate an SSN.No
Page RangeIndicate the page range for the search. Use a comma-separated list of page numbers or ranges. The first page starts at 1. Example: 1,2-5,7-.No
Simplify OutputEnable this for a consolidated output in a single list, which facilitates easier data reuse.No
Custom ProfilesA JSON string which adds options for the conversion process. See API Profiles for more.No

Source PDF URL & Google

When using Google Drive, it’s typically recommended to choose the File option. For more advanced file integration techniques, see Integrating File Sources with pdf.co.

Output

NameDescription
urlThe temporary URL on the PDF.co file server.
bodyAn object array containing the search results. This is visible only if the Simplified Object property is set to False.
match1An object that includes a single search result. Visible when the Simplified Object property is set to True.
match2An object holding another search result, following the same pattern as match1 for each output file.
outputLinkValidTillA timestamp which indicates how long the url will be available for.
errorDetails of any errors (if any).
statusThe response status code. If all good this will be 200.
jobIdThe unique identifier for the job.
creditsThe credits spent on the process.
remainingCreditsThe credits left on your account.
durationThe time it took for the process.