Skip to content

Overview

Turn documents into structured, validated JSON — and configure your account headlessly.

Authentication

Send your API key as Authorization: Bearer <key> or X-Api-Key: <key>. Keys carry scopes: parse (submit + read documents), manage (models/routers/sources/destinations/keys), admin (manage + keys/members/billing). New keys default to parse. Management endpoints also accept a logged-in session.

Response envelope

Every success response is wrapped. A single resource is { "data": { … } }; a list is { "data": [ … ], "meta": { "pagination": { … } } }. Errors are { "statusCode": 404, "statusMessage": "…" }.

Parsing, in three shapes

  1. One callPOST /v1/documents with file: { url } or file: { contents } (base64) and a strategy.
  2. By reference — upload once with POST /v1/files, then parse many times with file: { id }.
  3. Large / presignedPOST /v1/files with presign: true, PUT the bytes to the returned URL, then parse by file: { id }.

Parsing is async: you get 202 { data: { id, pollUrl } } — poll GET /v1/documents/{id} until status is processed.

Ids & relations

Every resource’s own key is id. A relation (e.g. a document’s model) is an id string by default; add ?expand=model to inline it as { id, name }.

Information

  • OpenAPI version: 3.1.0

Security scheme type: apiKey

Header parameter name: X-Api-Key

Security scheme type: http