How it works
- Register and upload a document.
POST /v1/documentsreturns a short-lived upload URL; send the file bytes with a singlePUT. - Start an extraction.
POST /v1/extractionsvalidates the document, charges the fixed per-document rate, and begins processing. - Get the result. Poll the extraction, or register a webhook endpoint
and receive a signed
extraction.completedevent. Typical turnaround is minutes.
Base URL
Request-Id header — include it when contacting support.
Environments
One base URL, two kinds of API keys:- Live (
ck_live_...) — real processing, billed against your usage pool. - Sandbox (
ck_sandbox_...) — instant fixture responses, never billed. Build and test your integration end to end before processing a real document. See Sandbox.
Quickstart
Extract your first document in five requests.