← All toolsFiles & Documentspdf_handlerAll editions

READ_PDF

Extracts all text from a PDF file. Returns text per page plus full combined text. Supports page range selection.

Parameters

NameTypeRequiredDescription
pathstringyesAbsolute path to the PDF file
start_pageinteger—First page to read (1-indexed, default: 1)
end_pageinteger—Last page to read (1-indexed, default: last page)

How to use it

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

Try saying
“read my pdf handler”

In a workflow

As a step in a multi-step workflow DAG:

json
{
  "id": "s1",
  "agent": "pdf_handler",
  "action": "READ_PDF",
  "args": {
    "path": "/Users/me/Documents/file.txt",
    "start_page": 1,
    "end_page": 1
  },
  "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":"READ_PDF","args":{"path":"/Users/me/Documents/file.txt","start_page":1,"end_page":1}}'

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