Skip to main content
This feature is currently in beta. The API may change.
Use the published jats and wcag processors through POST /api/v1/agent. These are fixed document tasks; you do not need to design a processor. Before you begin, make sure you have:
  1. A Datalab account with an API key
  2. Python 3.11+ installed
  3. The Datalab SDK: pip install datalab-python-sdk
  4. Your DATALAB_API_KEY environment variable set

Choose a Processor

Use page-based documents such as PDFs and scans. Spreadsheets cannot run these two processors. Both return a verdict and verifier_metrics in addition to any available artifact.

Run and Review

These examples allow a longer polling window for agent work. Choose max_polls and poll_interval for your workflow; they limit client polling, not the server’s processing time. If polling times out, keep the request ID and continue polling the existing request instead of submitting it again. The SDK helpers require SDK 0.6.0 or later. AsyncDatalabClient.run_agent() accepts the same options with await. For wcag, change processor to wcag and read accessible_pdf instead of jats_xml.
An available artifact or success=true does not establish conformance. Inspect finished, verdict and the verification results before using the output. A missing verdict, failed or errored blocking check, or unfinished run needs review. A passing verdict reports the checks that ran; it does not replace your journal’s submission review or an accessibility review of the resulting PDF.

Versions and Run Options

Use processor="jats@1.0" or processor="wcag@1.0" to pin the seeded version. Omitting the version selects the newest published version. The processor chooses XML or PDF output. mode="fast" or mode="balanced" controls the run budget; it is separate from verification_effort, which can be fast, balanced or accurate. The default effort is fast, so set it explicitly when comparing results. For a regional request, use file_url or an uploaded file reference with processing_location. Regional completion can return a signed result_url for the result JSON; current SDKs download it automatically.

Next Steps

Published Processors

Learn the shared run options and version addressing.

Document Conversion

Use Convert when you need Markdown, HTML, JSON or chunks.

Redaction

Remove selected information and review the redaction verdict.

Python SDK

Configure polling, errors and result handling.