jobs

Get job status and result

Changed on

Tenant-scoped durable job read. Jobs belonging to another tenant return 404. Batch jobs include cursor-paginated child summaries. Playground tokens (ocr:playground) and ocr:full keys are both accepted. Successful parse jobs return the originally requested output_format in result; use GET /jobs/{id}/result?format= to select an alternate stored representation without re-running OCR.

get/jobs/{id}

Request

  • Base URL: https://api.openparser.dev
  • URL: https://api.openparser.dev/jobs/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

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

Example:opj_V1StGXR8_Z5jdHi6B-myT

Durable OCR job identifier (opj_…).

Query parameters

cursorstring

Opaque pagination cursor for batch child summaries.

limitinteger

Maximum number of batch child summaries to return.

Response

Job status, progress, and result when available

idstring required

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

operation'parse' | 'extract' | '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
completed_atstring date-time nullable required
has_sourceboolean
source_media_typestring nullable
source_parse_job_idstring

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

extraction_schemaobject
ocr_modelstring nullable

OCR model used at admit time when recorded. Omitted when unknown. Jobs do not expose a durable OCR options snapshot.

pipeline_idstring required

Prefixed public id for a saved extraction pipeline (oppl_…).

pipeline_versioninteger nullable required

Snapshot of the saved extraction pipeline version at admit time, or null when pipeline_id is null.

review_status'pending' | 'approved' | 'rejected'

Changes

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the response property const value paddleocr-vl-1.6 was removed for the status

    • breaking

      the response property const value paddleocr-vl-1.6 was removed for the status

    • breaking

      the response property const value eigenpal-paddle-layout-v1 was removed for the status

    • breaking

      the response property const value eigenpal-paddle-layout-v1 was removed for the status

    • breaking

      the response property const value paddle was removed for the status

    • breaking

      the response property const value paddle was removed for the status

    • breaking

      the ////////////// response's property type changed from integer to number for status

    • breaking

      the ////////////// response's property type changed from integer to number for status

    • breaking

      the ////////////// response's property type changed from integer to number for status

    • breaking

      the ////////////// response's property type changed from integer to number for status

    • breaking

      the ///////////// response's property type changed from number to object for status

    • breaking

      the /////////// response's property type changed from integer to number for status

    • breaking

      the /////////// response's property type changed from integer to number for status

    • breaking

      the /////////// response's property type changed from integer to number for status

    • breaking

      the /////////// response's property type changed from integer to number for status

    • breaking

      the ////////// response's property type changed from number to object for status

    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • warning

      removed the optional property ///////////// from the response with the status

    • warning

      removed the optional property ///////////// from the response with the status

    • warning

      removed the optional property ///////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      added the new element enum value to the ///////////// response property for the response status

    • warning

      added the new element enum value to the ////////// response property for the response status

    • warning

      added the new link enum value to the ///////////// response property for the response status

    • warning

      added the new link enum value to the ////////// response property for the response status

    • warning

      added the new other enum value to the ///////////// response property for the response status

    • warning

      added the new other enum value to the ////////// response property for the response status

    • warning

      added the new query_answer enum value to the ///////////// response property for the response status

    • warning

      added the new query_answer enum value to the ////////// response property for the response status

    • warning

      added the new section enum value to the ///////////// response property for the response status

    • warning

      added the new section enum value to the ////////// response property for the response status

    • warning

      added the new selection_mark enum value to the ///////////// response property for the response status

    • warning

      added the new selection_mark enum value to the ////////// response property for the response status

    • warning

      added the new stamp enum value to the ///////////// response property for the response status

    • warning

      added the new stamp enum value to the ////////// response property for the response status

    • warning

      added the new table_cell enum value to the ///////////// response property for the response status

    • warning

      added the new table_cell enum value to the ////////// response property for the response status

    • warning

      added the new text_span enum value to the ///////////// response property for the response status

    • warning

      added the new text_span enum value to the ////////// response property for the response status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      removed the block enum value from the ///////////// response property for the response status

    • info

      removed the block enum value from the ////////// response property for the response status

    • info

      removed the checkbox enum value from the ///////////// response property for the response status

    • info

      removed the checkbox enum value from the ////////// response property for the response status

    • info

      removed the header_footer enum value from the ///////////// response property for the response status

    • info

      removed the header_footer enum value from the ////////// response property for the response status

    • info

      removed the heading enum value from the ///////////// response property for the response status

    • info

      removed the heading enum value from the ////////// response property for the response status

    • info

      removed the region enum value from the ///////////// response property for the response status

    • info

      removed the region enum value from the ////////// response property for the response status

    • info

      added 'propertyNames' constraint to the ///////// response property for the status

    • info

      added 'propertyNames' constraint to the ////// response property for the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property /////////// to the response with the status

    • info

      added the required property /////////// to the response with the status

    • info

      added the required property /////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status