Skip to main content

Document Processing Overview

Parselyze exposes two public document-processing modes:

  • Synchronous: parse now, get JSON in the same response
  • Asynchronous: submit a job now, fetch results later or receive them by webhook

Both modes use the same template-based extraction engine.

Which One Should You Choose?

Use caseRecommended mode
Immediate request/response flowSynchronous
Background workers or queuesAsynchronous
Webhook-driven automationAsynchronous
Multiple uploaded files in one requestSynchronous
ZIP archivesSynchronous
One file per background jobAsynchronous

Sync vs Async

FeatureSynchronousAsynchronous
Response styleJSON returned immediatelyJob returned immediately, result later
Upload shapefiles multipart fieldfile multipart field
Multiple filesYes, up to 10 uploaded filesNo
ZIP supportYesNo
WebhooksNoYes
PollingNot neededYes, via GET /v1/jobs/:jobId
Best forSimple parse requestsBackground and automation workflows

Shared Behavior

Both modes:

  • Require an existing template ID
  • Support PDFs and common image formats
  • Accept an optional language hint
  • Support fileUrl as an alternative to direct upload

Current Product Limits

  • Templates are created in the dashboard, not through the public API
  • Async processing supports one file per job
  • Scanned PDFs over 30 pages are not supported yet

Public Endpoints

  • Synchronous: POST /documents/parse
  • Asynchronous submit: POST /v1/documents/parse/async
  • Async job status: GET /v1/jobs/:jobId

Next Steps

  1. Synchronous Processing
  2. Asynchronous Processing
  3. Webhooks
  4. Error Handling