Sign in
parse

Parse multiple documents in one batch

Changed on

Admit up to 100 parse child jobs in one durable batch. Every uploaded file must be mapped exactly once by file_index. Partial child failures are preserved in batch results. Parent status derivation for mixed outcomes is defined on JobStatus.

post/parse/batch

Request

  • Base URL: https://api.openparser.dev
  • URL: https://api.openparser.dev/parse/batch
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Client-supplied idempotency key. Required on every parse or extract POST. Must be unique per distinct request body for a given tenant and operation.

Response

Durable batch job admitted. Location points at the parent batch job resource.

idstring required

Prefixed public id for an OCR job (opj_…).

operation'parse_batch' | 'extract_batch' required
status'queued' | 'running' | 'succeeded' | 'failed' | 'indeterminate' required

Durable job status. For batch parent jobs, status is derived from children after each child transition:

  1. If any child is non-terminal, the parent remains queued only while every child is queued; it becomes running once any child is running or terminal.
  2. When every child is terminal and any child is indeterminate, the parent is indeterminate.
  3. When every child is terminal, none are indeterminate, and any child is failed: the parent is failed if zero children succeeded, otherwise succeeded (mixed success/failure closes as parent succeeded while preserving failed children in summaries).
  4. When every child is succeeded, the parent is succeeded.

Partial failures are always retained on child summaries; parent status does not drop failed children from results.

output_format'openparser@1' | 'raw' required
created_atstring date-time required
updated_atstring date-time required
child_countinteger required

Example response

{
  "id": "opj_V1StGXR8_Z5jdHi6B-myT"
}

Changes

  • 4561194517a8Revision changes
    • breaking

      added 'propertyNames' constraint to the request property ///

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////