Sign in
jobs

Get a parse job result representation

Changed on

Return the selected parse wire body for a tenant-owned succeeded parse job. format defaults to the job's original output_format. Fresh dual-artifact parses can serve either openparser@1 or raw from object storage without re-running HPS or charging pages. Historical jobs only serve the representation already present in result_json; unavailable alternates return 422 result_format_unavailable with guidance. Non-terminal jobs return 409 job_not_terminal. Playground tokens (ocr:playground) and ocr:full keys are both accepted.

get/jobs/{id}/result

Request

  • Base URL: https://api.openparser.dev
  • URL: https://api.openparser.dev/jobs/{id}/result
  • 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

format'openparser@1' | 'raw'

Parse representation to return. Defaults to the job's original output_format when omitted. Fresh parses store both representations as immutable object-store artifacts; historical jobs only expose the representation already present in result_json. Requesting an unavailable alternate returns 422 and never re-runs OCR.

Response

Selected parse representation (ParsedDocument or RawParseResult)

OR

Changes

  • 4561194517a8Revision changes
    • 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 paddle was removed for 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

    • 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