Sign in
parse

Parse a document synchronously

Changed on

Admit a parse job, wait up to the sync wait limit, and return the selected terminal parse representation when ready. output_format defaults to the versioned provider-neutral openparser@1; raw returns a stable provider envelope around the selected provider's untouched successful result. Terminal failed within the wait window returns 422 ErrorResponse; terminal indeterminate returns 504 ErrorResponse. Returns 202 with a durable job reference and Location if the wait limit expires first.

Example (multipart/form-data):

curl -X POST 'https://api.openparser.dev/parse' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H "Idempotency-Key: $(uuidgen 2>/dev/null || openssl rand -hex 16)" \
  -F 'request={"ocr_model":"paddleocr-vl-1.6","output_format":"openparser@1"};type=application/json' \
  -F 'file=@./document.pdf'
post/parse

Request

  • Base URL: https://api.openparser.dev
  • URL: https://api.openparser.dev/parse
  • 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

Terminal parse result in the selected openparser@1 or raw representation

OR

Changes

  • 4561194517a8Revision changes
    • breaking

      added 'propertyNames' constraint to the request property /

    • 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 request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • 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