How to Test PDFs with Applitools Eyes
Compare generated PDFs with approved visual baselines using Applitools Eyes, Autonomous, or ImageTester, and learn when ScreenshotNeo is a simpler fit.
Applitools supports PDF testing through more than one workflow: run PDF checks as a batch job in Eyes, open a PDF in an Applitools Autonomous custom flow, or use the Applitools-maintained ImageTester CLI for standalone document files. Choose based on whether your PDFs are part of an application flow, whether you need document interactions such as page navigation or text assertions, and what your selected SDK currently supports. Applitools’ PDF testing page describes these routes; the precise PDF API and setup can differ by product and SDK.
Choose a PDF testing route
| Route | Use it when | What to verify |
|---|---|---|
| Eyes PDF batch job | You need to compare generated PDFs against approved baselines as a batch. | Check the current PDF setup for your Eyes project and SDK. The SDK selector has a PDFs/Images category, but the available references do not establish one universal PDF API across SDKs. |
| Autonomous custom flow | The PDF is a starting URL or appears during a browser flow, and you need document interactions as well as visual comparison. | The current PDF page describes page navigation, text assertions, fillable forms, and uploaded user PDFs referenced from test steps. |
| ImageTester CLI | You have standalone PDFs or a collection of document files to inspect. | Follow the maintained repository for current installation and command syntax; do not assume old tutorial commands still apply. |
Applitools describes PDF support and product capabilities in its PDF testing overview. Its ImageTester repository documents the CLI route for PDFs and other document formats. For direct opening and interactions in Autonomous, see the Applitools announcement.
How visual PDF regression testing works
A visual checkpoint is compared with an approved baseline. The first run can establish the reference; later runs report visual differences. A reviewer decides whether a change is expected, then saves an approved baseline update or keeps the existing reference if the change is a defect. This is the general Eyes visual testing lifecycle; consult the PDF workflow documentation for product-specific setup.
- Generate the PDF from known test data and save or expose it through the workflow your chosen route supports.
- Configure the appropriate Eyes PDF batch, Autonomous flow, or ImageTester process using its current documentation.
- Run the check and inspect the reported changed pages and regions.
- Decide whether each difference is an intended document change or a regression.
- Save a new baseline only after reviewing the changes you intend to accept.
Applitools’ general documentation explains the checkpoint, comparison, review, and baseline cycle. The system overview describes the test suite, Eyes SDK, application driver, Eyes server, and Test Manager roles in the broader visual testing system.
Make comparisons useful and repeatable
- Stabilize test inputs. Use consistent business data and generation settings where possible so visual changes reflect a code or template change rather than unrelated content.
- Identify dynamic fields. Dates, identifiers, account data, and other changing values can create differences. Decide whether to make the inputs stable or handle those regions through capabilities documented for your selected workflow.
- Review high-impact areas closely. Dense tables, footnotes, and wrapped legal text can shift in ways that affect meaning or readability. Inspect the exact page and region rather than accepting a broad change without review.
- Separate content changes from layout changes. A changed amount may be valid test data; a clipped amount or shifted column may indicate a layout defect. Use the review context and known inputs to make that call.
- Keep baseline updates governed. Record why an accepted change is expected and avoid approving a large set of differences without checking them.
- Pin down the supported workflow. Select the current SDK and project documentation before implementing. The official Java Selenium quickstart is a web-test quickstart, not a universal PDF tutorial.
Code and setup: use the workflow-specific documentation
The source materials available for this guide do not provide a complete, currently verified PDF-specific code sample for a named Eyes SDK or a verified ImageTester invocation. Avoid copying a web checkpoint example and assuming it applies to PDF files. Start with the SDK chooser and confirm the PDF workflow for your SDK, or use the current ImageTester repository instructions for standalone files. For Autonomous, configure the PDF as the flow’s start URL or navigate to it mid-flow, following the current product guidance.
For general Eyes context, the system overview describes how the SDK and driver send checkpoints to the Eyes server and how results and baselines are reviewed in Test Manager. The Java Selenium quickstart lists prerequisites for its own web-test sample; those should not be treated as universal PDF requirements.
Troubleshooting PDF visual checks
| Symptom | Likely cause | What to do |
|---|---|---|
| The test cannot open or process the PDF | The selected SDK or route may not support the assumed direct-file workflow, or the setup is incomplete. | Confirm current PDF support for the exact SDK or use the documented Autonomous or ImageTester route. Do not infer a universal API from the SDK category label. |
| Many regions differ between runs | Generated content or document rendering may be changing. | Stabilize test data and generation settings, then inspect whether differences align with dynamic fields or a genuine layout shift. |
| A baseline update hides a defect | Changes were accepted without reviewing affected pages and regions. | Re-run against the prior approved baseline where possible and review each relevant difference before saving another update. |
| A text assertion or form interaction is unavailable | The feature may be specific to Autonomous custom flows rather than the chosen Eyes SDK workflow. | Check the current Autonomous documentation and keep product-specific capabilities distinct from general Eyes SDK behavior. |
| CLI instructions fail | An older tutorial or copied command may not match the maintained tool’s current syntax. | Use the current README in the maintained ImageTester repository. |
Performance, reliability, and cost considerations
Batching is a natural fit when many standalone PDFs need processing; an application flow is a better fit when a PDF is one step in a larger journey. In either case, keep the generation inputs repeatable and review baselines deliberately. The sources cited here do not provide comparable runtime benchmarks, a universal SDK support matrix, or pricing details, so check the current product documentation and commercial terms for your selected Applitools product before planning scale or cost.
Or skip the browser setup
If your goal is to capture a web page as an image or PDF, ScreenshotNeo is a website screenshot API and MCP server. Its one-request API returns PNG, JPEG, WebP, or PDF. See the ScreenshotNeo API documentation.
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webpimport requests
r = requests.get("https://api.screenshotneo.com/v1/shot", params={"access_key": "YOUR_API_KEY", "url": "https://stripe.com"}, timeout=90)
open("shot.webp", "wb").write(r.content)const q = new URLSearchParams({ access_key: 'YOUR_API_KEY', url: 'https://stripe.com' });
const res = await fetch(`https://api.screenshotneo.com/v1/shot?${q}`);ScreenshotNeo removes cookie banners, newsletter popups, and chat widgets before capture. Bot checks, blank pages, failed loads, and cache hits are not billed, and response headers report the page verdict and billing status. Its MCP server includes screenshot, page-info, and PDF-capture tools for AI agents. The free plan includes 1,000 screenshots per month with no card; paid plans start at $5 for 3,000. These features capture web pages; they do not replace visual regression testing of arbitrary generated PDF files against approved baselines.
Create a free ScreenshotNeo account for 1,000 screenshots a month with no card.
FAQ
Can Eyes compare PDFs automatically?
Applitools describes PDF checks in Eyes as a batch job. Confirm the current setup for your SDK and project before implementing it.
Can Autonomous test an interactive PDF flow?
Applitools’ current PDF materials describe opening a PDF in a custom flow, navigating pages, asserting text, and supporting fillable forms. Confirm availability and setup in current Autonomous guidance.
Is ScreenshotNeo an alternative to Applitools Eyes for PDF regression testing?
No. ScreenshotNeo captures web pages as images or PDFs; Eyes is the visual regression workflow for comparing checkpoints with baselines. Use ScreenshotNeo when you need a clean website capture, and use a documented Applitools PDF route when you need document baseline comparisons.
Where should I find runnable PDF code?
Use the current documentation for the specific SDK or tool you choose. The source references here do not verify one universal SDK code sample or current CLI invocation.
