Skip to content
Coming soon. The hosted API is not live yet, and this page describes the planned service as of 16 November 2026. Get notified when it opens.

search

Find a text in a PDF, with page and position of each match.

POST /v1/search

Input one file, sent as multipart/form-data; the optional options part is a JSON object
Output JSON
Credits [credit rate: no claim ID yet]
Limits [size, page and time limits: no claim ID yet]
Reads or changes the document reads only
Error statuses 400, 413, 422, 500, 501, 504 (see Errors)
Option Type Required Default Description
case_insensitive boolean no false Ignore case. Default false.
limit integer no 1000 Most matches returned. Default 1000, [limit: no claim ID yet]
password string no Password of an encrypted document.
query string yes The text to find, or a regular expression when regex is true.
regex boolean no false Treat query as a regular expression. Default false.
Terminal window
curl -sS -f -X POST "$PDFLUENT_API_URL/v1/search" \
-H "x-api-key: $PDFLUENT_API_KEY" \
-F 'options={"query":"Safety"}' \
-o result.json

The key goes in the x-api-key header; see Authentication. Every response carries x-pdfluent-pages and x-pdfluent-credits.