Document parse

Document parse

ParseRail converts any invoice, receipt, EOB, ERA, or COI, as a PDF or image, into structured, validated JSON.

Cost: 10 credits ($0.10) — charged only on success.

Accepts async: true for long documents — see the Async & webhooks guide.

post/v1/parse

Request

  • Base URL: https://api.thecompound.tech
  • URL: https://api.thecompound.tech/v1/parse
  • Auth: HTTP bearer

Headers

ParseRail-Dry-Run'1' | 'true'

Send 1 to dry-run the call. ParseRail runs auth, the throttle, body validation and the balance precheck. It returns 200 with the cost and the status a live call would get. No model runs and nothing is charged, so a key with a zero balance works. Dry runs count against the per-key rate limit.

Idempotency-Keystring

Key for one logical operation. Same body replays the result for 24 hours; a different body with the same key returns 409.

Request body

fileUrlstring uri

Provide a public URL to a PDF or image.

textstring

Provide raw text if you already have it.

Example request

{
  "file": {
    "mimeType": "application/pdf"
  }
}

Response

The call succeeded. The response contains result fields and a usage envelope. With ParseRail-Dry-Run: 1 the body is a DryRun object instead.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.