← All toolsFiles & Documentspdf_handlerAll editions

SEARCH_PDF

Searches for a text pattern across all pages of a PDF. Returns matching pages and context around each match.

Parameters

NameTypeRequiredDescription
pathstringyesAbsolute path to the PDF file
querystringyesText or regex pattern to search for
case_sensitiveboolean—Case-sensitive search (default false)

How to use it

You normally trigger this by describing what you want in chat — the agent selects SEARCH_PDF automatically. For example:

Try saying
“use pdf handler to search …”

In a workflow

As a step in a multi-step workflow DAG:

json
{
  "id": "s1",
  "agent": "pdf_handler",
  "action": "SEARCH_PDF",
  "args": {
    "path": "/Users/me/Documents/file.txt",
    "query": "example query",
    "case_sensitive": true
  },
  "depends_on": [],
  "outputs": []
}

Direct call

For scripting, call it directly via POST /execute_tool. Every tool returns { success, message, data }.

bash
curl -X POST http://127.0.0.1:8000/execute_tool \
  -H "Content-Type: application/json" \
  -d '{"tool_name":"SEARCH_PDF","args":{"path":"/Users/me/Documents/file.txt","query":"example query","case_sensitive":true}}'

Part of the pdf_handler plugin. Browse the full Plugin & Tool Catalog or the relevant feature guide.