Extract structured data synchronously

Admit a single extract job from file bytes, file_id, or a tenant-owned succeeded parse_job_id, then run schema-constrained OpenRouter extraction via llm_model. A parse_job_id source reuses the canonical ParsedDocument (from dual artifacts or legacy result_json) without OCR or another page charge; historical raw-only parses return 422 canonical_result_unavailable. Wait up to the sync wait limit and return ExtractionTerminalResult when ready. Terminal failed within the wait window returns 422; terminal indeterminate returns 504. Returns 202 with a durable job reference and Location if the wait expires.

Authorization

bearerAuth

AuthorizationBearer <token>

Existing Eigenpal API key presented as a bearer token.

In: header

Header Parameters

Idempotency-Key*string

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

Length1 <= length <= 256

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?file

Source document bytes (PDF, PNG, or JPEG). Required unless request.file_id references an existing Eigenpal reusable file.

Formatbinary

request*

Single extract config. Provide either pipeline_id or inline extraction config. The source is exactly one of multipart file bytes, file_id, or tenant-owned succeeded parse_job_id. Parse reuse is single-extract-only, forbids ocr_model / ocr_options, does not run OCR, and adds no page charge. parse_job_id is part of idempotency identity.

Response Body

`application/json`

curl -X POST "https://example.com/extract" \  -H "Idempotency-Key: 7f9f2f3d-0f8a-4f0a-9a2b-2f6f0a7d2c11" \  -H "Authorization: Bearer $OPENPARSER_API_KEY" \  -F request="{}"

{  "output": {    "invoice_number": "INV-1001",    "total_due": 1234.56  },  "parsed_document": {    "output_format": "openparser@1",    "document_id": "doc_01h2example",    "provenance": {      "provider": "paddle",      "model": "paddleocr-vl-1.6"    },    "text": "Total due: $1,234.56",    "markdown": "Total due: $1,234.56",    "pages": [      {        "number": 1,        "width": 1700,        "height": 2200,        "unit": "pixel",        "element_ids": [          "e0"        ],        "reading_order": [          "e0"        ]      }    ],    "elements": [      {        "id": "e0",        "kind": "text",        "role": "paragraph",        "text": "Total due: $1,234.56",        "spans": [],        "languages": [],        "locations": [          {            "page_number": 1,            "bbox": {              "left": 72,              "top": 180,              "right": 420,              "bottom": 220            }          }        ]      }    ],    "text_annotations": [],    "relations": [],    "assets": []  },  "llm_model": "openai/gpt-5.6-terra",  "attempts": [    {      "index": 0,      "kind": "primary",      "llm_model": "openai/gpt-5.6-terra",      "status": "succeeded",      "input_tokens": 1200,      "output_tokens": 84,      "cost_usd": 0.0042    }  ],  "usage": {    "input_tokens": 1200,    "output_tokens": 84,    "cost_usd": 0.0042  }}

{  "id": "opj_7f9f2f3d0f8a4f0a9a2b2f6f0a7d2c11",  "operation": "parse",  "status": "queued",  "output_format": "openparser@1",  "created_at": "2026-07-17T12:00:00Z",  "updated_at": "2026-07-17T12:00:00Z"}

{  "error": {    "code": "malformed_request",    "message": "multipart field `request` is not valid JSON",    "request_id": "req_01h2example",    "retryable": false  }}

{  "error": {    "code": "unauthorized",    "message": "invalid API key",    "request_id": "req_01h2example",    "retryable": false  }}

{  "error": {    "code": "insufficient_credits",    "message": "tenant has insufficient credits for admission",    "request_id": "req_01h2example",    "retryable": false  }}

{  "error": {    "code": "forbidden",    "message": "API key lacks required scope",    "request_id": "req_01h2example",    "retryable": false  }}

{  "error": {    "code": "idempotency_conflict",    "message": "Idempotency-Key was already used with a different request body",    "request_id": "req_01h2example",    "retryable": false  }}

{  "error": {    "code": "limit_exceeded",    "message": "source exceeds 50 MiB admission limit",    "request_id": "req_01h2example",    "retryable": false,    "details": {      "limit": "max_input_bytes",      "max_value": 52428800    }  }}

{  "error": {    "code": "unsupported_media_type",    "message": "only PDF, PNG, and JPEG uploads are accepted",    "request_id": "req_01h2example",    "retryable": false  }}

{  "error": {    "code": "unsupported_ocr_model",    "message": "unknown OCR model registry name",    "request_id": "req_01h2example",    "retryable": false,    "details": {      "ocr_model": "paddleocr-vl-9.9"    }  }}

{  "error": {    "code": "rate_limited",    "message": "request rate limit exceeded",    "request_id": "req_01h2example",    "retryable": true  }}

{  "error": {    "code": "source_upload_failed",    "message": "source upload failed",    "request_id": "req_01h2example",    "retryable": true  }}

{  "error": {    "code": "provider_indeterminate",    "message": "job outcome indeterminate",    "request_id": "req_01h2example",    "retryable": true  }}

Extract structured data synchronously

Authorization

Header Parameters

Request Body

Response Body

200application/json

202application/json

400application/json

401application/json

402application/json

403application/json

409application/json

413application/json

415application/json

422application/json

429application/json

503application/json

504application/json

Example invoice

Example groundedInvoice

Example unsupportedModel

Example unsupportedLlmModel

Example groundingUnsupportedSchema

Example syncFailed

Example rate

Example tenant

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`