View as Markdown
PDF.co icon

PDF.co ACTION

Search Text in PDF

Search text in PDF and get coordinates. Supports regular expressions. See docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PDF.co account once, then configure and run Search Text in PDF from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "pdf_co-pdf-search-text",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pdf_co: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    searchString: "Search String",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Text in PDF inputs
Property Type Description
url URL string
URL to the source file. Supports links from Google Drive, Dropbox and from built-in PDF.co files storage.
Required
searchString Search String string
Text to search for on pages.
Required
pages Pages string
For ALL pages just leave this param empty. 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 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). 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.
Optional
wordMatchingMode Word Matching Mode string
Values can be either ‘SmartMatch’, ‘ExactMatch’ or ‘None’.
Optional
password PDF Password string
Password of PDF file.
Optional
regexSearch Regex Search boolean
Set to true to enable regular expressions for search string. false by default.
Optional
httpusername HTTP Username string
HTTP auth user name if required to access source url.
Optional
httppassword HTTP Password string
HTTP auth password if required to access source url.
Optional
name Name string
File name for generated output.
Optional
expiration Expiration integer
Output link expiration in minutes. Default is 60 (i.e. 60 minutes or 1 hour).
Optional
inline Inline boolean
Must be one of: true to return data as inline or false to return link to output file (default).
Optional
async Async boolean
Runs processing asynchronously. Returns JobId.
Optional
profiles Profiles any
Use this parameter to set additional configuration for fine tuning and extra options. Explore PDF.co for profile examples.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
pdf_co-pdf-search-text
Version
0.0.2
App
PDF.co
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes