Skip to content

Overview

Parse documents into structured, validated JSON — and configure your account headlessly. Authenticate with an API key (Authorization: Bearer <key> or X-Api-Key).

Key scopes — a key carries one or more:

  • parse — submit documents + read results (the Parse endpoints under /api/v1).
  • manage — create/edit models, routers, sources, destinations (the Management endpoints under /api).
  • admin — manage + API keys, members, billing.

New keys default to parse only. Management endpoints also accept a logged-in user session.

Uploading a file — two ways:

  1. Inline base64POST /v1/models/{modelId}/parse with JSON { fileBase64, fileName } (one request, up to ~12 MB).
  2. Presigned (recommended, no size limit) — POST /v1/models/{modelId}/uploads to get a one-time S3 URL, PUT the raw file to it, then POST /v1/models/{modelId}/parse with { sourceKey }.

Then poll GET /v1/documents/{documentId} for the structured result.

Information

  • OpenAPI version: 3.1.0

Security scheme type: apiKey

Header parameter name: X-Api-Key

Security scheme type: http